-
Notifications
You must be signed in to change notification settings - Fork 13
Open
Labels
Not Readynot ready to be assigned.not ready to be assigned.🟢 ParallelizableThese tasks are independent. Any developer can pick these up now (if in the current phase).These tasks are independent. Any developer can pick these up now (if in the current phase).
Description
7.67 Update Backend Documentation
Summary
Update backend documentation to reflect the new TypeScript + Prisma architecture, dependency upgrades, and testing/deployment workflows. Ensure onboarding and maintenance docs accurately describe the current system.
Tasks
- Update
README.md(backend-specific or root as appropriate) to cover:
- Tech stack (TypeScript, Prisma, Apollo, Express, MongoDB)
- Project structure (app/,app/types/,app/data/, etc.)
- Development workflow (pnpm dev,pnpm test,pnpm build) - Update or create backend-focused docs in
/docs:
- Architecture overview (data flow, GraphQL, Prisma, server)
- TypeScript conventions and strict-mode expectations
- Database layer (Prisma schema, migrations)
- Testing strategy (unit, integration, subscriptions) - Update migration documentation to summarize:
- Mongoose → Prisma transition
- Babel → TypeScript toolchain transition
- Major dependency upgrades - Ensure deployment documentation references the new build and start commands
- Remove or revise outdated references to:
- Babel-based builds
- Mongoose as primary ORM
- Deprecated packages or APIs - Commit updated documentation
Expected Behavior
Documentation provides accurate guidance for running, developing, testing, and deploying the backend with the current stack and conventions.
Tech Notes
- Include short code snippets and command examples where they clarify workflows.
- Consider adding links between docs to help new contributors navigate the material.
Acceptance Criteria
- README and backend docs describe the current architecture and workflows
- No references to obsolete tools (Babel, Mongoose, deprecated packages) remain
- A new contributor can follow the docs to set up, run, and test the backend successfully
Test Instructions
- Walk through the documented setup steps in a fresh clone or clean environment.
- Run
pnpm dev,pnpm test, andpnpm buildfollowing the docs. - Adjust documentation if any step is unclear, missing, or inaccurate.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
Not Readynot ready to be assigned.not ready to be assigned.🟢 ParallelizableThese tasks are independent. Any developer can pick these up now (if in the current phase).These tasks are independent. Any developer can pick these up now (if in the current phase).
Type
Projects
Status
Todo