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

Documentation: user and dev #12

Open
s4rify opened this issue Aug 1, 2023 · 0 comments
Open

Documentation: user and dev #12

s4rify opened this issue Aug 1, 2023 · 0 comments
Assignees
@s4rify

Comments

@s4rify
Copy link
Collaborator

s4rify commented Aug 1, 2023

We need user and developer documentation on

  • how to set up the project in order to add features/fix bugs
  • how to navigate the code
  • how to use the app
  • where to find releases

It would be neat if the documentation can be generated (partially) automatically from the code using Doxygen or something similar. I will investigate, whether that is feasible and also how we can add this step to the Ci/CD pipeline.
@s4rify s4rify self-assigned this Aug 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@s4rify s4rify

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@s4rify