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

Improve documentation #7

Open
asgersvenning opened this issue Sep 19, 2024 · 1 comment
Open

Improve documentation #7

asgersvenning opened this issue Sep 19, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@asgersvenning
Copy link
Owner

Currently the documentation page is not super easy to navigate and the following things need to be implemented:

1) A collapse-able menu on the left-hand side, where you can see the currently selected page and its' nesting in the content hierarchy.
2) Cross-links to referenced functions throughout the documentation.
3) Links to source code both on the documentation page, but also the Github source.
4) A proper front page.
5) Examples/tutorials.

It would also be great to remove the intermediate index.html and perhaps also (although at a lower priority) think about mobile accessibility.

@asgersvenning asgersvenning added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Sep 19, 2024
@asgersvenning
Copy link
Owner Author

It would also be great with an installation and testing guide, as well as system requirements.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant