Reorganize documentation#54
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Backend coverageBackend coverage
|
Frontend coverageFrontend coverage
|
cdsaidev
approved these changes
Jun 17, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Tidies the repository's documentation to follow the common convention of
keeping reference docs under a
docs/directory, leaving the root to theREADMEentry point.Changes
DEPLOYMENT.md→docs/deployment.md, and fix its internalrender.yamllink for the new location.README.mddeployment reference to point at the new path.docs/README.mdas an index linking the deployment guide, studentfeature proposals, and admin completion TODO.
No content was rewritten — this is a structure-only change.
Notes / follow-ups (not in this PR)
architecture.mddescribing how frontend + backend + Prisma fittogether would be a good next addition.
admin-completion-todo.mdmay be better tracked as GitHub issues.