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.
1.2 KiB
1.2 KiB
title, description
| title | description |
|---|---|
| CalMiner Architecture Documentation | arc42-based architecture documentation for the CalMiner project |
Architecture documentation (arc42 mapping)
This folder mirrors the arc42 chapter structure (adapted to Markdown).
Files:
01_introduction_and_goals.md02_architecture_constraints.md03_context_and_scope.md04_solution_strategy.md05_building_block_view.md06_runtime_view.md07_deployment_view.md08_concepts.md09_architecture_decisions.md10_quality_requirements.md11_technical_risks.md12_glossary.md
Mapping notes:
docs/architecture.mdanddocs/architecture_overview.mdcontain high-level content that will be split into these chapter files.docs/quickstart.mdcontains developer quickstart, migrations, testing and current status and will remain as a separate quickstart reference.
Next steps:
- Move relevant sections from
docs/architecture.mdanddocs/architecture_overview.mdinto the appropriate chapter files. - Expand each chapter with diagrams, examples, and references to code (files and modules).
- Add links from the top-level
README.mdtodocs/architecture/README.mdanddocs/quickstart.md.