Skip to content

docs: update project readmes#24

Merged
ChuuuDwarf merged 2 commits into
mainfrom
docs/update-readmes
Jun 2, 2026
Merged

docs: update project readmes#24
ChuuuDwarf merged 2 commits into
mainfrom
docs/update-readmes

Conversation

@hank1101444

Copy link
Copy Markdown
Collaborator

No description provided.

Copilot AI review requested due to automatic review settings June 2, 2026 11:50

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md into a structured overview with badges, architecture diagram, deployment modes, and feature/env tables.
  • Replace frontend/README.md boilerplate with a Next.js-focused guide (scripts, routes, structure, UI conventions).
  • Expand backend/README.md into 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.

@ChuuuDwarf ChuuuDwarf left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@ChuuuDwarf ChuuuDwarf merged commit f7402cd into main Jun 2, 2026
8 checks passed
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.

3 participants