Skip to content

Commit 43bb95b

Browse files
author
hk-2029
committed
docs: fix deploy failure — add repository-guide to nav, remove deleted file-organisation, fix broken links
1 parent cebb138 commit 43bb95b

4 files changed

Lines changed: 5 additions & 5 deletions

File tree

documentation/wiki/developer-guide/internals/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This section documents the internal structure of the SimPaths codebase — how i
55
## Sections
66

77
- [SimPaths API](api.md) — public API reference
8-
- [File Organisation](file-organisation.md) — directory and package layout
8+
- [Repository Guide](../repository-guide.md) — directory and package layout
99
- [The SimPathsModel Class](simpaths-model.md) — the central model class
1010
- [Start Class Implementation](start-class-implementation.md) — SimPaths-specific start class
1111
- [MultiRun Implementation](multirun-implementation.md) — SimPaths-specific MultiRun class

documentation/wiki/developer-guide/internals/multirun-implementation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ To use a different config file:
3030
java -jar multirun.jar -config my_run.yml
3131
```
3232

33-
For configuration options, see the annotated `config/default.yml`. For the data pipeline and further reference, see [`documentation/`](documentation/README.md).
33+
For configuration options, see the annotated `config/default.yml`. For the data pipeline and further reference, see [`documentation/`](../../developer-guide/repository-guide.md).
3434

3535
<!-- Projections for a workhorse model parameterised to the UK context are reported in [Bronka, P. et al. (2023). *SimPaths: an open-source microsimulation model for life course analysis* (No. CEMPA6/23), Centre for Microsimulation and Policy Analysis at the Institute for Social and Economic Research*](https://www.microsimulation.ac.uk/publications/publication-557738/), which closely reflect observed data throughout a 10-year validation window. -->
3636

documentation/wiki/developer-guide/repository-guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -271,7 +271,7 @@ When IO is enabled, this package creates projected income paths for birth cohort
271271

272272
CSV filenames follow the pattern `<EntityClass><RunNumber>.csv`. With a single run the suffix is `1`; with multiple runs each run produces its own numbered file.
273273

274-
For a description of the variables in output CSV files, see `documentation/SimPaths_Variable_Codebook.xlsx`. For a description of each `reg_*`, `align_*`, and `scenario_*` input file, see [Model Parameterisation](wiki/overview/parameterisation.md) on the website.
274+
For a description of the variables in output CSV files, see `documentation/SimPaths_Variable_Codebook.xlsx`. For a description of each `reg_*`, `align_*`, and `scenario_*` input file, see [Model Parameterisation](../overview/parameterisation.md) on the website.
275275

276276
---
277277

@@ -288,7 +288,7 @@ The pipeline has three independent parts: (1) initial populations, (2) regressio
288288
| **UKHLS** (Understanding Society) | Main household panel survey; waves 1 to O (UKDA-6614-stata) | Requires EUL licence from UK Data Service |
289289
| **BHPS** (British Household Panel Survey) | Historical predecessor to UKHLS; used for pre-2009 employment history | Bundled with UKHLS EUL |
290290
| **WAS** (Wealth and Assets Survey) | Biennial survey of household wealth; waves 1 to 7 (UKDA-7215-stata) | Requires EUL licence from UK Data Service |
291-
| **EUROMOD / UKMOD** | Tax-benefit microsimulation system | See [Tax-Benefit Donors (UK)](wiki/getting-started/data/tax-benefit-donors-uk.md) on the website |
291+
| **EUROMOD / UKMOD** | Tax-benefit microsimulation system | See [Tax-Benefit Donors (UK)](../getting-started/data/tax-benefit-donors-uk.md) on the website |
292292

293293
### Part 1 — Initial populations (`input/InitialPopulations/compile/`)
294294

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,7 @@ nav:
119119
- Developer Guide:
120120
- developer-guide/index.md
121121
- Working in GitHub: developer-guide/working-in-github.md
122+
- Repository Guide: developer-guide/repository-guide.md
122123
- JAS-mine Architecture:
123124
- developer-guide/jasmine/index.md
124125
- Project Structure: developer-guide/jasmine/project-structure.md
@@ -129,7 +130,6 @@ nav:
129130
- SimPaths Internals:
130131
- developer-guide/internals/index.md
131132
- SimPaths API: developer-guide/internals/api.md
132-
- File Organisation: developer-guide/internals/file-organisation.md
133133
- The SimPathsModel Class: developer-guide/internals/simpaths-model.md
134134
- Start Class Implementation: developer-guide/internals/start-class-implementation.md
135135
- MultiRun Implementation: developer-guide/internals/multirun-implementation.md

0 commit comments

Comments
 (0)