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

Updated Documentation #265

Merged
merged 8 commits into from
May 17, 2024
Merged

Updated Documentation #265

merged 8 commits into from
May 17, 2024

Conversation

ansengarvin
Copy link
Collaborator

@ansengarvin ansengarvin commented May 17, 2024

  • Split the database section of backend.md into its own document, database.md
    • backend.md links to database.md
    • Content of database documentation is the same, but formatted slightly differently
  • Created new documentation in api.md
    • This aims to create a simple step-by-step tutorial on creating a new API endpoint, with the goal of showing a new developer how to make one.
    • It uses some content from (and links to) overview.md, so this may end up being redundant.
  • Updated run.md documentation with some commands that weren't added.

Closes #252

@ansengarvin ansengarvin marked this pull request as ready for review May 17, 2024 04:24
@xnought xnought merged commit b64f2f6 into main May 17, 2024
2 checks passed
@xnought xnought deleted the db_doc branch May 17, 2024 18:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Separate DB documentation
2 participants