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

XP-007 Add docs #1

Open
rchaput opened this issue Oct 25, 2019 · 0 comments
Open

XP-007 Add docs #1

rchaput opened this issue Oct 25, 2019 · 0 comments
Assignees
@rchaput
Labels
documentation Improvements or additions to documentation

Comments

@rchaput
Copy link
Owner

rchaput commented Oct 25, 2019

Documentation should be added in a docs/ folder at the root of the project. It should contain:

  • the code documentation (extracted from the Python docstrings)
  • a "user manual" on how to use the application
  • a "dev manual" on how to contribute, how to delve into the source code, what is the goal of each module,...

The documentation should be set up as Github Pages for easy access.
@rchaput rchaput added the documentation Improvements or additions to documentation label Oct 25, 2019
@rchaput rchaput self-assigned this Oct 25, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@rchaput rchaput

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@rchaput