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

Refactor gh-pages into tutorials #79

Open
erleben opened this issue Apr 19, 2022 · 0 comments
Open

Refactor gh-pages into tutorials #79

erleben opened this issue Apr 19, 2022 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@erleben
Copy link
Collaborator

erleben commented Apr 19, 2022

Currently, gh-pages is set up to document code in a way similar to pep8/Doxygen type of documentation. The process is manual, and a bit redundant since the documentation already exists in code. Hence, it does not offer a lot of extra help to end-users.

Instead, there is a need for tutorials that explains how to use our code. That is on the level of modules and sub-modules. Information that shows code examples that one can quickly copy-paste from, explanations of the design ideas behind the code, good advice for best usage, and possible discussions of DO and DONT aspects.

@erleben erleben added the enhancement New feature or request label Apr 19, 2022
@erleben erleben added the documentation Improvements or additions to documentation label Apr 19, 2022
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
Projects
None yet
Development

No branches or pull requests

2 participants