Nia documentation · Latest
Documentation versions
Choose documentation for your installed version and understand stable links, immutable snapshots and release promotion.Nia versions its API, administrator and user documentation together. Use documentation matching your installed server and clients.
Latest documentation
/docs/latest/ points to the newest successfully promoted documentation snapshot. Stable links such as /docs, /docs/api and /docs/setup resolve to the same released content.
latest changes after a public GitHub release exists, its exact tag has been validated and the Forgejo-side promotion checks pass. A patch release with an explicit no-documentation-impact review can keep the existing snapshot, so the latest app and documentation version numbers need not always be identical.
Immutable release snapshots
Published snapshots use full versions such as /docs/v3.6.0/. Each registry entry records the app tag and commit, source documentation commit and SHA-256 content hash. A snapshot is never silently overwritten.
When a release changes documentation, promotion creates a complete new snapshot. When documented application areas change but the text does not, an explicit no-impact review is required. Verified version-only changes are excluded. A patch release with unchanged documentation does not create a duplicate snapshot solely to mirror its app version number.
Version selection
The version selector lists only published documentation snapshots. Preparing a target version does not add it to the selector or expose it through a separate URL.
The selector keeps your current page where that page exists in the selected version. If an older snapshot lacks it, the selector opens that version’s documentation home. Documentation search remains scoped to the selected version.
Use an immutable version URL for a stable reference. The internal next working tree has no public route and is not included in navigation, search or the sitemap.
Preparing documentation
src/content/docs/next/ is a complete documentation tree, not a list of changes. Immediately after promotion it is reset to the new released content and becomes the base for the following release.
Its .release.json manifest names the base and target versions, documentation impact and reviewed areas. Set ready only after checking the content, API coverage, links and production build. For changed documentation:
npm run docs:prepare -- v4.0.0 changed user-guides api installation configuration operations
If documented application areas changed without requiring text changes, prepare an explicit no-impact review and reason instead. Promotion uses the prepared tree when its target matches the eligible public release.
Forgejo-side promotion
The private Forgejo workflow checks the public GitHub Releases API every five minutes, and also supports manual runs. GitHub does not call Forgejo or hold its credentials.
For a new eligible release, promotion checks out the exact public tag, compares changed application areas and validates API route coverage against next. A separate read-only job verifies the promotion artifact, snapshot integrity and its source checkout before persistence.
The persistence job commits and pushes the validated snapshot metadata before building and deploying the promoted site. Validation failures stop persistence; build or deployment failures stop publication but can leave the promotion already committed. Check the workflow result when diagnosing a difference between the registry and the live site. Preparing documentation locally does not publish a release, change the stable download feed or deploy the website.