refactor: Update documentation links for improved navigation; remove obsolete architecture file
This commit is contained in:
@@ -20,11 +20,11 @@ Frontend components are server-rendered Jinja2 templates, with Chart.js powering
|
||||
|
||||
### Current implementation status (summary)
|
||||
|
||||
- Currency normalization, simulation scaffold, and reporting service exist; see `docs/quickstart.md` for full status and migration instructions.
|
||||
- Currency normalization, simulation scaffold, and reporting service exist; see [quickstart](docs/quickstart.md) for full status and migration instructions.
|
||||
|
||||
## MVP Features (migrated)
|
||||
|
||||
The following MVP features and priorities were migrated from `docs/mvp.md`.
|
||||
The following MVP features and priorities were defined during initial planning.
|
||||
|
||||
### Prioritized Features
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Implementation Plan (extended)
|
||||
|
||||
This file contains the migrated implementation plan (MVP features, steps, and estimates) originally in `docs/implementation_plan.md`.
|
||||
This file contains the implementation plan (MVP features, steps, and estimates).
|
||||
|
||||
## Project Setup
|
||||
|
||||
@@ -126,4 +126,4 @@ Goal: Identify core MVP features, acceptance criteria, and quick estimates.
|
||||
1. Scaffold Reporting endpoints (`services/reporting.py`, `routes/reporting.py`, front-end Dashboard, tests).
|
||||
1. Add CI job for tests and coverage.
|
||||
|
||||
See `docs/architecture/13_ui_and_style.md` for the UI template audit, layout guidance, and next steps.
|
||||
See [UI and Style](docs/architecture/13_ui_and_style.md) for the UI template audit, layout guidance, and next steps.
|
||||
|
||||
@@ -23,12 +23,12 @@ Explain the static structure: modules, components, services and their relationsh
|
||||
|
||||
## Architecture overview (migrated)
|
||||
|
||||
This overview complements `docs/architecture.md` with a high-level map of CalMiner's module layout and request flow.
|
||||
This overview complements [architecture](docs/architecture/README.md) with a high-level map of CalMiner's module layout and request flow.
|
||||
|
||||
Refer to the detailed architecture chapters in `docs/architecture/`:
|
||||
|
||||
- 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`
|
||||
- Module map & components: [Building Block View](docs/architecture/05_building_block_view.md)
|
||||
- Request flow & runtime interactions: [Runtime View](docs/architecture/06_runtime_view.md)
|
||||
- Simulation roadmap & strategy: [Solution Strategy](docs/architecture/04_solution_strategy.md)
|
||||
|
||||
Currency normalization and backfill tooling have been added (see `scripts/backfill_currency.py` and related migrations) to support canonical currency lookups across cost tables.
|
||||
Currency normalization and backfill tooling have been added (see [backfill_currency.py](scripts/backfill_currency.py) and related migrations) to support canonical currency lookups across cost tables.
|
||||
|
||||
@@ -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.
|
||||
|
||||
Reference in New Issue
Block a user