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.

Sign up for GitHub

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

Jump to bottom

Improve structure of the user guide #13626

Open
r-brink opened this issue Jan 11, 2024 · 0 comments
Open

Improve structure of the user guide #13626

r-brink opened this issue Jan 11, 2024 · 0 comments
Assignees
@r-brink
Labels
accepted Ready for implementation documentation Improvements or additions to documentation

Comments

@r-brink
Copy link
Contributor

r-brink commented Jan 11, 2024

Description

I believe we should improve the structure of the user guide. The homepage is a sort of copy of the Github repo readme and it takes some clicks to get to the content in the user guide.

My suggestion implement the following improvements:

  • enter on user guide
  • move current homepage an overview page with some code to get started
  • change 'basics' to a single page 'getting started' page
  • make some small improvements here and there along the way

Link

No response
@r-brink r-brink added the documentation Improvements or additions to documentation label Jan 11, 2024
@stinodego stinodego added the accepted Ready for implementation label Jan 11, 2024
@r-brink r-brink mentioned this issue Jan 11, 2024
Merged
This was referenced Jan 15, 2024
Merged
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@r-brink r-brink

Labels
accepted Ready for implementation documentation Improvements or additions to documentation
Projects
Backlog
Archived in project
Milestone
No milestone
Development

No branches or pull requests
2 participants
@stinodego @r-brink