allucanget/calminer
2
0
Fork 0
Code Pull Requests Actions Packages Releases Activity

refactor: Update documentation links for improved navigation; remove obsolete architecture file

Browse Source
This commit is contained in:
zwitschi
2025-10-21 18:18:38 +02:00
parent 4b3a15ed15
commit 9ed2a70521
7 changed files with 19 additions and 69 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/architecture/README.md
View File

@@ -22,13 +22,4 @@ Files:
- `11_technical_risks.md`
- `12_glossary.md`
Mapping notes:
- `docs/architecture.md` and `docs/architecture_overview.md` contain high-level content that will be split into these chapter files.
- `docs/quickstart.md` contains developer quickstart, migrations, testing and current status and will remain as a separate quickstart reference.
Next steps:
1. Move relevant sections from `docs/architecture.md` and `docs/architecture_overview.md` into the appropriate chapter files.
2. Expand each chapter with diagrams, examples, and references to code (files and modules).
3. Add links from the top-level `README.md` to `docs/architecture/README.md` and `docs/quickstart.md`.
- [quickstart](docs/quickstart.md) contains developer quickstart, migrations, testing and current status and will remain as a separate quickstart reference.