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.
2.6 KiB
2.6 KiB
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 flowdocs/architecture/02_architecture_constraints.md— constraintsdocs/architecture/03_context_and_scope.md— context and external actorsdocs/architecture/04_solution_strategy.md— solution strategy and simulation roadmapdocs/architecture/04_solution_strategy_extended.md— implementation plan & MVP roadmapdocs/architecture/05_building_block_view.md— system components and static structuredocs/architecture/06_runtime_view.md— reporting pipeline and runtime interactionsdocs/architecture/07_deployment_view.md— deployment and infrastructure notesdocs/architecture/08_concepts.md— domain concepts and data modeldocs/architecture/09_architecture_decisions.md— architecture decision recordsdocs/architecture/10_quality_requirements.md— quality targets and checksdocs/architecture/11_technical_risks.md— technical risks and mitigationsdocs/architecture/12_glossary.md— glossarydocs/architecture/13_ui_and_style.md— UI templates, macros and style guidancedocs/architecture/14_testing_ci.md— testing strategy and CI guidancedocs/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:
- Open the chapter file you want to expand under
docs/architecture/. - 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. - After edits, run
scripts/check_docs_links.pyto validate local links.