Skip to content

docs: add comprehensive API setup and architecture guide - #10

Draft
dragosandreibobu wants to merge 2 commits into
mainfrom
agent/readme-documentation
Draft

docs: add comprehensive API setup and architecture guide#10
dragosandreibobu wants to merge 2 commits into
mainfrom
agent/readme-documentation

Conversation

@dragosandreibobu

Copy link
Copy Markdown
Contributor

What changed

  • Added a complete README for the Django API foundation.
  • Documented the current HTTP surface, PostgreSQL/Supabase configuration, uv setup, migrations, admin access and tests.
  • Added a custom architecture SVG and Mermaid diagrams.
  • Distinguished current capabilities from the planned concept-graph domain model.
  • Explained why tests use isolated in-memory SQLite and recorded current configuration limitations.

Why

The repository had no README, so contributors could not reliably determine how to configure the database, start Django, use the health endpoint or run tests.

Validation

The documentation was cross-checked against pyproject.toml, .env.example, config/settings.py, config/test_settings.py, config/urls.py, core/views.py, pytest.ini and tests/test_health.py.

@vercel

vercel Bot commented Aug 5, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
curricula-live-api Ready Ready Preview Aug 5, 2026 8:44pm

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.

1 participant