From 43bb95bd9adc956d324ee636d8a886acd3286ccb Mon Sep 17 00:00:00 2001 From: hk-2029 Date: Tue, 17 Mar 2026 15:53:02 +0000 Subject: [PATCH] =?UTF-8?q?docs:=20fix=20deploy=20failure=20=E2=80=94=20ad?= =?UTF-8?q?d=20repository-guide=20to=20nav,=20remove=20deleted=20file-orga?= =?UTF-8?q?nisation,=20fix=20broken=20links?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- documentation/wiki/developer-guide/internals/index.md | 2 +- .../wiki/developer-guide/internals/multirun-implementation.md | 2 +- documentation/wiki/developer-guide/repository-guide.md | 4 ++-- mkdocs.yml | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/documentation/wiki/developer-guide/internals/index.md b/documentation/wiki/developer-guide/internals/index.md index 25aa30320..1bd4468bf 100644 --- a/documentation/wiki/developer-guide/internals/index.md +++ b/documentation/wiki/developer-guide/internals/index.md @@ -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 diff --git a/documentation/wiki/developer-guide/internals/multirun-implementation.md b/documentation/wiki/developer-guide/internals/multirun-implementation.md index ee798acbd..71ea39ffc 100644 --- a/documentation/wiki/developer-guide/internals/multirun-implementation.md +++ b/documentation/wiki/developer-guide/internals/multirun-implementation.md @@ -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). diff --git a/documentation/wiki/developer-guide/repository-guide.md b/documentation/wiki/developer-guide/repository-guide.md index e571662e2..f7b2c0c9e 100644 --- a/documentation/wiki/developer-guide/repository-guide.md +++ b/documentation/wiki/developer-guide/repository-guide.md @@ -271,7 +271,7 @@ When IO is enabled, this package creates projected income paths for birth cohort CSV filenames follow the pattern `.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. --- @@ -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/`) diff --git a/mkdocs.yml b/mkdocs.yml index 31873be04..0654bab9f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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 @@ -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