> For the complete documentation index, see [llms.txt](https://docs.cortex.aic.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cortex.aic.io/reference/maintainers.md).

# Maintainers

The reader pages in `getting-started`, `lifecycle`, `areas`, `research`, and `reference` are curated. Check them against the current Razor pages and `CortexNavigationCatalogue.cs` after any user-facing change. Keep the menu words exactly as the application shows them.

The 81 pages in `workflows` come from the current in-app Help catalogue.

{% stepper %}
{% step %}

## Build the Help project

From `src`, build `AIC.Cortex.UI.Help`.
{% endstep %}

{% step %}

## Export the full user guide

Run:

```powershell
pwsh -NoProfile -File Scripts/Export-FullUserGuide.ps1
```

{% endstep %}

{% step %}

## Export the GitBook content

Run:

```bash
node Scripts/Export-GitBook.mjs
```

This script also writes `SUMMARY.md`.
{% endstep %}

{% step %}

## Review the changes

Review the `SUMMARY.md` diff before commit.
{% endstep %}
{% endstepper %}

The standalone `src/FULL-USER-GUIDE.MD` export is an intermediate file. The book does not need it when imported.

Use short action sentences in the curated pages. Give one action per numbered step when possible. Name buttons, tabs, fields, and menu items exactly. Give a prerequisite, a visible check, and the effect on retained records. The wording follows [ASD-STE100](https://www.asd-ste100.org/) principles where practical. Formal ASD-STE100 compliance needs a trained editorial check against the current standard and the approved CORTEX technical terms.

GitBook reads `.gitbook.yaml`, `README.md`, and `SUMMARY.md` from this directory.

{% stepper %}
{% step %}

## Map the GitBook space

Map a GitBook space to this directory in a GitHub or GitLab repository.
{% endstep %}

{% step %}

## Import the content

Import in the repository-to-GitBook direction.
{% endstep %}
{% endstepper %}

See [GitBook content configuration](https://gitbook.com/docs/docs-as-code/git-sync/content-configuration).

{% hint style="warning" %}
The current CORTEX origin uses Azure DevOps. GitBook's documented Git Sync options are GitHub and GitLab. Do not assume an Azure DevOps push publishes this book.
{% endhint %}
