docs: add C4 architecture model#72
Draft
NikolayS wants to merge 1 commit into
Draft
Conversation
Add a C4 software architecture model for the repo: - docs/architecture/workspace.dsl: Structurizr DSL source of truth (system context, containers, CLI & Reporter components) - docs/architecture/README.md: GitHub-renderable Mermaid C4 diagrams (L1 context, L2 containers, L3 components) - Link the model from the top-level README Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01GrG9pynE6hPRG8JYsdKGxZ
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
2 participants
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.
What
Adds a C4 software architecture model for the repository under
docs/architecture/.Why
The repo had no architecture documentation. The C4 model captures how the system fits together — from users and external systems down to containers and components — making the codebase easier to onboard to and reason about.
Contents
docs/architecture/workspace.dsl— Structurizr DSL, the single source of truth. Defines people (Engineer/DBA, AI agents), external systems (Target PostgreSQL, console.postgres.ai, Supabase, Amazon Managed Prometheus, LLM providers), and all PostgresAI containers/components with their relationships. Renders all C4 levels and is editable via Structurizr Lite.docs/architecture/README.md— GitHub-renderable Mermaid C4 diagrams for at-a-glance reading without tooling:README.md— link to the model from the Links table.Notes
The model was derived from
docker-compose.yml, thecli/,reporter/,monitoring_flask_backend/sources, and project docs. Diagrams are intended to be kept in sync withworkspace.dslas the architecture evolves.🤖 Generated with Claude Code
https://claude.ai/code/session_01GrG9pynE6hPRG8JYsdKGxZ
Generated by Claude Code