docs: update project readmes#24
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Documentation-only refresh of the project's README files. The root README is restructured to highlight architecture, deployment modes (Docker, local dev, CI/K3s/Argo CD), tech stack, default accounts, environment variables, and feature/API entry points. The frontend and backend READMEs are rewritten from boilerplate/minimal content into structured guides covering tech stack, scripts, routes/modules, project layout, and env variables.
Changes:
- Rewrite root
README.mdinto a structured overview with badges, architecture diagram, deployment modes, and feature/env tables. - Replace
frontend/README.mdboilerplate with a Next.js-focused guide (scripts, routes, structure, UI conventions). - Expand
backend/README.mdinto a FastAPI guide covering API routes, env variables, migrations, tests, and Docker services.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Restructured top-level project overview with new sections for architecture, modes, env, and features. |
| frontend/README.md | Replaced create-next-app boilerplate with project-specific frontend documentation. |
| backend/README.md | Expanded backend docs with route registry, env vars, migrations, tests, and compose services. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
No description provided.