Skip to content

Commit 2e78a4a

Browse files
committed
Fix documentation links and income binning
- Add user-guide.md to docs and navigation - Update all HOW_TO_SUMMARIZE.md references to user-guide.md - Fix income summary to use income_bin instead of raw values - Rename 'Validation System' to 'Summary System' in nav
1 parent a7c1ee4 commit 2e78a4a

File tree

7 files changed

+369
-21
lines changed

7 files changed

+369
-21
lines changed

mkdocs.yml

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -33,23 +33,16 @@ nav:
3333
- Getting Started:
3434
- Installation: install.md
3535
- Quick Start: index.md#quick-start
36-
- Validation System:
37-
- Complete Guide: validation-system.md
36+
- User Guide: user-guide.md
37+
- Summary System:
3838
- Generate Summaries: generate-summaries.md
39+
- Summary Reference: summaries.md
3940
- CTRAMP Data Model: data-model.md
4041
- Custom Summaries: custom-summaries.md
41-
- External Data Integration: external-data.md
42-
- Deploy Dashboard: deploy-dashboard.md
43-
- Configuration Reference: configuration.md
44-
- Dashboard: dashboard.md
45-
- Summaries: summaries.md
42+
- External Data: external-data.md
43+
- Configuration: configuration.md
4644
- Development:
47-
- Code Flow & Execution: code-flow.md
48-
- Development Tasks: validation-development.md
4945
- Contributing Guide: contributing.md
50-
- Reference:
51-
- Consolidation Proposal: ../summary/CONSOLIDATION_PROPOSAL.md
52-
- Deployment Guide: ../summary/DASHBOARD_DEPLOYMENT.md
5346

5447
markdown_extensions:
5548
- admonition

tm2py_utils/docs/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -456,7 +456,7 @@ binning_specs:
456456

457457
## See Also
458458

459-
- [HOW_TO_SUMMARIZE.md](../summary/validation/HOW_TO_SUMMARIZE.md) - Complete user guide with examples
459+
- [HOW_TO_SUMMARIZE.md](user-guide.md) - Complete user guide with examples
460460
- [README.md](../summary/validation/README.md) - Toolkit overview
461461
- [summaries.md](summaries.md) - Summary system documentation
462462
- [generate-summaries.md](generate-summaries.md) - Detailed generation guide

tm2py_utils/docs/generate-summaries.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -359,7 +359,7 @@ python summarize_model_run.py "path/to/ctramp_output"
359359

360360
The new summary `trip_mode_by_income.csv` will be generated automatically.
361361

362-
See [HOW_TO_SUMMARIZE.md](../summary/validation/HOW_TO_SUMMARIZE.md) for detailed examples.
362+
See [User Guide](user-guide.md) for detailed examples.
363363

364364
---
365365

@@ -523,7 +523,7 @@ The tool uses ASCII-safe symbols and should work on all Windows terminals. If yo
523523
- **Validate data quality:** Review validation warnings and investigate issues
524524

525525
See also:
526-
- [HOW_TO_SUMMARIZE.md](../summary/validation/HOW_TO_SUMMARIZE.md) - Detailed user guide
526+
- [User Guide](user-guide.md) - Detailed user guide
527527
- [README.md](../summary/validation/README.md) - Toolkit overview
528528
- [PREPROCESSING_NOTES.md](../summary/validation/PREPROCESSING_NOTES.md) - Advanced summaries requiring preprocessing
529529

tm2py_utils/docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ python summarize_model_run.py "C:/path/to/ctramp_output"
4242
```
4343

4444
**📚 New to the validation system?** Check out:
45-
- **[HOW_TO_SUMMARIZE.md](../summary/validation/HOW_TO_SUMMARIZE.md)** - Complete user guide
45+
- **[User Guide](user-guide.md)** - Complete user guide
4646
- **[README.md](../summary/validation/README.md)** - Toolkit overview
4747
- **[Summaries Guide](summaries.md)** - System documentation
4848

@@ -82,7 +82,7 @@ Analysis tools for synthetic population outputs:
8282
## Documentation
8383

8484
- [Installation Guide](install.md)
85-
- [Summaries User Guide](../summary/validation/HOW_TO_SUMMARIZE.md) - **Start here for generating summaries**
85+
- [Summaries User Guide](user-guide.md) - **Start here for generating summaries**
8686
- [Summary System Documentation](summaries.md)
8787
- [Toolkit README](../summary/validation/README.md)
8888
- [Contributing](contributing.md)

tm2py_utils/docs/summaries.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -299,6 +299,6 @@ To analyze multiple model runs:
299299

300300
## Next Steps
301301

302-
- See [HOW_TO_SUMMARIZE.md](../summary/validation/HOW_TO_SUMMARIZE.md) for detailed user guide
302+
- See [HOW_TO_SUMMARIZE.md](user-guide.md) for detailed user guide
303303
- Check [README.md](../summary/validation/README.md) for toolkit overview
304304
- Review [data_model/ctramp_data_model.yaml](../summary/validation/data_model/ctramp_data_model.yaml) for all summary definitions

0 commit comments

Comments
 (0)