Skip to content

docs: fix deploy failure — add repository-guide to nav, remove delete… #412

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hk-2029 merged 1 commit into from
Mar 17, 2026
Merged

docs: fix deploy failure — add repository-guide to nav, remove delete… #412

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion documentation/wiki/developer-guide/internals/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This section documents the internal structure of the SimPaths codebase — how i
## Sections

- [SimPaths API](api.md) — public API reference
- [File Organisation](file-organisation.md) — directory and package layout
- [Repository Guide](../repository-guide.md) — directory and package layout
- [The SimPathsModel Class](simpaths-model.md) — the central model class
- [Start Class Implementation](start-class-implementation.md) — SimPaths-specific start class
- [MultiRun Implementation](multirun-implementation.md) — SimPaths-specific MultiRun class
2 changes: 1 addition & 1 deletion documentation/wiki/developer-guide/internals/multirun-implementation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ To use a different config file:
java -jar multirun.jar -config my_run.yml
```

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

<!-- 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. -->

Expand Down
4 changes: 2 additions & 2 deletions documentation/wiki/developer-guide/repository-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,7 @@ When IO is enabled, this package creates projected income paths for birth cohort

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.

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.
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.

---

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

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

Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,7 @@ nav:
- Developer Guide:
- developer-guide/index.md
- Working in GitHub: developer-guide/working-in-github.md
- Repository Guide: developer-guide/repository-guide.md
- JAS-mine Architecture:
- developer-guide/jasmine/index.md
- Project Structure: developer-guide/jasmine/project-structure.md
Expand All @@ -129,7 +130,6 @@ nav:
- SimPaths Internals:
- developer-guide/internals/index.md
- SimPaths API: developer-guide/internals/api.md
- File Organisation: developer-guide/internals/file-organisation.md
- The SimPathsModel Class: developer-guide/internals/simpaths-model.md
- Start Class Implementation: developer-guide/internals/start-class-implementation.md
- MultiRun Implementation: developer-guide/internals/multirun-implementation.md
Expand Down
Loading