Home
Back to docs

Product Help

Temporarily override the text of a guide when something published is wrong — and why the real correction happens somewhere else.

The guides for this platform are written in the repository and ship with each release. This page is an override layer on top of them: a way to correct a sentence that is live and wrong right now, without waiting for the next release.

It is not a second authoring system. If your correction is not urgent, it belongs in the guide file itself, so the published text stays the single source of truth.

Where an override is actually visible

Only on the public documentation site, and only where that site is served — the operator's own host.

The Page Guide drawer in the admin reads the guides that shipped inside the release, not the database. That is deliberate: help has to work with no database, no network and no AI service. The side effect is that an override does not reach the drawer; that text stays as it was until the next release.

Each field falls back on its own

Change only the title and the summary and body keep tracking the published text, updating with later releases. Correcting one sentence does not freeze the whole article.

What "stale override" means

Every override records which version of the text it was written against. When the published article later changes, the two no longer match and the state becomes stale override.

The override still wins — that is part of the contract — but it is now visibly hiding newer text rather than doing so silently. The edit window shows you the current published text so you can decide: update your edit, or restore the published version.

Search follows your correction

An override changes what is found as well as what is displayed. Correct a word and searching for the new one finds the article; searching for the wording you replaced no longer does.

That second half is intentional. An override says the published wording is wrong right now, so leaving it searchable would hand someone a result whose page does not contain the word they typed.

Anything you did not override stays searchable as published — change only the title and the body's words still find the article.

This applies to the public documentation site. The drawer searches the guides that shipped in the release, for the reason above.

Developed by LogaTech Powered by LogaCore