zwitschi
4b3a15ed15
- Introduced multiple architecture documentation files covering building block view, runtime view, deployment view, concepts, architecture decisions, quality requirements, technical risks, glossary, UI and styling, testing, CI, and development setup. - Migrated existing content from `architecture_overview.md` and `implementation_plan.md` into structured documentation. - Created scripts for checking broken links in documentation and formatting Markdown files for consistency. - Updated quickstart guide to provide clearer setup instructions and usage overview. - Removed outdated MVP features and testing strategy documents to streamline documentation.
42 lines
2.6 KiB
Markdown
42 lines
2.6 KiB
Markdown
# Architecture Documentation
|
|
|
|
This folder contains the project's architecture documents split into arc42-inspired chapters (Markdown).
|
|
|
|
Start here (per-chapter files live under `docs/architecture/`):
|
|
|
|
- `docs/architecture/README.md` — mapping and next steps (overview of the chapter layout)
|
|
- `docs/architecture/01_introduction_and_goals.md` — overview and runtime flow
|
|
- `docs/architecture/02_architecture_constraints.md` — constraints
|
|
- `docs/architecture/03_context_and_scope.md` — context and external actors
|
|
- `docs/architecture/04_solution_strategy.md` — solution strategy and simulation roadmap
|
|
- `docs/architecture/04_solution_strategy_extended.md` — implementation plan & MVP roadmap
|
|
- `docs/architecture/05_building_block_view.md` — system components and static structure
|
|
- `docs/architecture/06_runtime_view.md` — reporting pipeline and runtime interactions
|
|
- `docs/architecture/07_deployment_view.md` — deployment and infrastructure notes
|
|
- `docs/architecture/08_concepts.md` — domain concepts and data model
|
|
- `docs/architecture/09_architecture_decisions.md` — architecture decision records
|
|
- `docs/architecture/10_quality_requirements.md` — quality targets and checks
|
|
- `docs/architecture/11_technical_risks.md` — technical risks and mitigations
|
|
- `docs/architecture/12_glossary.md` — glossary
|
|
- `docs/architecture/13_ui_and_style.md` — UI templates, macros and style guidance
|
|
- `docs/architecture/14_testing_ci.md` — testing strategy and CI guidance
|
|
- `docs/architecture/15_development_setup.md` — local development setup
|
|
|
|
Overview (migrated content):
|
|
|
|
This repository includes an architecture overview that complements the chapter files above and maps high-level module layout and request flow into the per-chapter documents.
|
|
|
|
Key pointers:
|
|
|
|
- Module map & components: `docs/architecture/05_building_block_view.md`
|
|
- Request flow & runtime interactions: `docs/architecture/06_runtime_view.md`
|
|
- Simulation roadmap & strategy: `docs/architecture/04_solution_strategy.md`
|
|
|
|
Developer quickstart, migrations, testing and current implementation status remain in `docs/quickstart.md` (canonical quickstart). If you prefer, the quickstart can be split into specific chapters, but currently it serves as a single onboarding document.
|
|
|
|
To continue expanding the architecture docs:
|
|
|
|
1. Open the chapter file you want to expand under `docs/architecture/`.
|
|
2. Move or add content from other docs into the chapter and ensure the chapter references code files (e.g., `services/simulation.py`, `routes/reporting.py`) using relative links.
|
|
3. After edits, run `scripts/check_docs_links.py` to validate local links.
|