Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make the docs page better structured #748

Merged
merged 2 commits into from
Sep 1, 2023
Merged

Make the docs page better structured #748

merged 2 commits into from
Sep 1, 2023

Conversation

matteobachetti
Copy link
Member

@matteobachetti matteobachetti commented Aug 24, 2023

The old page was basically a TOC, kind of unstructured (e.g. the getting started drown between installation and many advanced applications):
Screenshot 2023-08-24 at 14 29 52
As a side effect, the left-hand side menu was basically uninformative.

I made a few things: I put the installation instructions and the main features directly in the first page. Then, I split the TOC into different parts, divided by level. As a result, also the left-hand side menu is richer, giving more information to new users.

Screenshot 2023-08-24 at 14 29 22

image

Also, I made the docs only CI work... I separated that part in another PR: #749

@codecov
Copy link

codecov bot commented Aug 24, 2023

Codecov Report

Merging #748 (1b01cc3) into main (7844fc8) will decrease coverage by 0.06%.
Report is 5 commits behind head on main.
The diff coverage is n/a.

❗ Current head 1b01cc3 differs from pull request most recent head 2054c89. Consider uploading reports for the commit 2054c89 to get more accurate results

@@            Coverage Diff             @@
##             main     #748      +/-   ##
==========================================
- Coverage   97.13%   97.08%   -0.06%     
==========================================
  Files          42       42              
  Lines        7929     7929              
==========================================
- Hits         7702     7698       -4     
- Misses        227      231       +4     

see 2 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Copy link
Member

@dhuppenkothen dhuppenkothen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Much better! Yay!

@matteobachetti matteobachetti added this pull request to the merge queue Sep 1, 2023
Merged via the queue into main with commit 5d633c1 Sep 1, 2023
@matteobachetti matteobachetti deleted the fix-docs branch September 1, 2023 23:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants