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 #17

Open
hectron opened this issue Sep 25, 2021 · 0 comments
Open

Documentation #17

hectron opened this issue Sep 25, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@hectron
Copy link
Contributor

hectron commented Sep 25, 2021

We currently don't have any documentation on how this application works, what it's solving, etc. We should write some documents and post them to the wiki of the project.

Consider writing them in a directory outside of the application (e.g. docs/) and using Github actions to publish them to the wiki.
@hectron hectron added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Sep 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@hectron