Skip to content

docs: add centralized documentation hub#945

Merged
maxachis merged 11 commits intodevfrom
docs/add-documentation-hub
Feb 10, 2026
Merged

docs: add centralized documentation hub#945
maxachis merged 11 commits intodevfrom
docs/add-documentation-hub

Conversation

@maxachis
Copy link
Copy Markdown
Contributor

@maxachis maxachis commented Feb 10, 2026

Summary

  • Creates a docs/ directory with 10 documentation files covering architecture, API (overview, authentication, endpoints), development (setup, database, testing, workflow), and troubleshooting.
  • Slims down README.md to a quick-start guide with links to the new docs.
  • All content written from the actual codebase — covers the dual Flask/FastAPI architecture, all 29 v2 namespaces + 3 v3 routers, auth model, database schema, CI pipeline, and common issues.

New files

docs/
├── README.md                      # Index linking to all docs
├── architecture.md                # System design, request flow, directory structure
├── api/
│   ├── overview.md                # v2 vs v3, auto-docs, migration plan
│   ├── authentication.md          # JWT, API keys, OAuth, permissions
│   └── endpoints.md               # All endpoint namespaces
├── development/
│   ├── setup.md                   # Full setup (uv + pip, Docker DB, sandbox)
│   ├── database.md                # Schema, query builders, Alembic
│   ├── testing.md                 # Running/writing tests, CI
│   └── workflow.md                # Branching, PRs, CI checks, code standards
└── troubleshooting.md             # Common issues and fixes

Test plan

  • Verify all markdown renders correctly on GitHub
  • Verify all internal links between docs resolve
  • Verify links back to existing in-repo READMEs work
  • Review content accuracy against current codebase

🤖 Generated with Claude Code

@maxachis maxachis merged commit f3a3c45 into dev Feb 10, 2026
5 checks passed
@maxachis maxachis deleted the docs/add-documentation-hub branch February 10, 2026 23:25
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.

2 participants