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

Add/Improve documentation #64

Open
lost1227 opened this issue Oct 20, 2023 · 0 comments
Open

Add/Improve documentation #64

lost1227 opened this issue Oct 20, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@lost1227
Copy link
Member

We need more documentation in several areas:

  1. The README should show off attendance-app: what it is and what it does.
  2. The development environment instructions are very barebones and could be more fleshed out.
  3. It would be nice to have some documentation of project architecture, such as the difference between the api/web, and the structure of code in both the api and in the web.
  4. It would also be nice to have some documentation of how to configure the deploy script.
  5. It would be nice to have some documentation of how to update dependencies, especially when dependabot alerts us to new security vulnerabilities.
@lost1227 lost1227 added the documentation Improvements or additions to documentation label Oct 20, 2023
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
Projects
None yet
Development

No branches or pull requests

1 participant