Update the docs

Every published page has one canonical Markdown source. Update that source and the website, search, and Datastat agent all receive the same reviewed answer.

The fastest path

Use Edit this page at the bottom of any document. GitHub opens the correct source file in your browser. Make the change, describe it, and open a pull request for review. Most corrections need no local setup.

Today, authors use GitHub's browser editor or edit Markdown locally. There is no separate visual CMS in this version.

Choose the correct source

There are two source types. Use Edit this page to open the right file. Its target is generated from the source_repository and source_path in that file's frontmatter.

Page type	Canonical source	Where to make the change
Datastat Docs pages	`datastat/docs-v2`	Edit the file under `docs/datastat/`.
Product pages	`datastat/docs` or the named product repository	Edit the upstream `source_path`, then import a reviewed revision.

Do not edit an imported copy

JudoNet, Video CutterV2, Video Ingester, and FairReplay Markdown in docs-v2 is generated. A direct edit can look correct and even pass validation, but the next npm run docs:import will overwrite it. Fix the canonical product source instead.

Edit in the browser

Use this route for a typo, unclear sentence, missing step, or other focused correction.

Open the page that needs work.
Select Edit this page in the footer.
Sign in to GitHub if asked.
Edit the Markdown. Keep the existing frontmatter unless its metadata also changed.
Create a branch and pull request from the GitHub editor.
Explain what changed, why it is correct, and how a reviewer can verify it.

If you know that something is wrong but cannot supply the final wording, suggest a documentation correction instead. Include the page URL, the problem, and the expected answer. Never include credentials, personal data, customer data, or private access details.

Edit Datastat Docs locally

Use a local checkout when the change spans several pages, changes navigation, or needs a full preview.

Open the datastat/docs-v2 repository and install its dependencies.
```
npm install
npm run dev
```
Edit the canonical file under docs/datastat/ and preview it at the local URL printed by Next.js, normally http://localhost:3000/docs/datastat.
For a new page, or a change to its title, description, route, group, or order, also update localPages in scripts/import-legacy-docs.mjs, then regenerate the manifest.
Before importing, either keep each referenced source repository as a sibling checkout or install GitHub CLI and confirm gh auth status succeeds with access to the private Datastat repositories. The importer verifies every source at its pinned commit.
```
npm run docs:import -- ../docs
```

Run the checks before requesting review.

npm run docs:validate
npm run lint
npm run typecheck
npm run build

Commit the source and any regenerated manifest together, then open a pull request.

For a body-only change to an existing Datastat page, the import step is not required.

Update a product page

Product pages use a reviewed, pinned revision so an upstream change cannot silently alter published instructions.

Select Edit this page to open the upstream source_repository and source_path.
Change that file in its canonical repository and complete its product review.
Merge the source change and record the immutable commit SHA.
In docs-v2, update SOURCE_REVISION in scripts/import-legacy-docs.mjs. Update any matching sourceRevision entries in scripts/reviewed-public-assets.json.
Run npm run docs:import -- ../docs to regenerate product pages and the manifest.
Run the validation, lint, typecheck, and build commands above.
Review the generated diff and open the docs-v2 pull request.

This two-step publication is deliberate: the product repository owns the meaning, while docs-v2 owns the reviewed website snapshot.

Add or replace an image

Do not copy a screenshot or logo directly into public/media. Public media is an approved allowlist.

Put the canonical image in the repository that owns it.
Remove credentials, personal information, customer names, private URLs, and other sensitive details.
Add the exact source revision, path, SHA-256 hash, dimensions, privacy decision, and publication decision to scripts/reviewed-public-assets.json.
Run the importer and validation.
Reference the generated public path from the page.

A Screenshot pending privacy review placeholder means the legacy page referred to an image that has not passed those checks. Approve a sanitized replacement in the asset registry and run the importer to replace the placeholder with the real image.

Review and publish

Automated checks prove that the page is structurally safe to publish. They do not prove that its instructions are true. A person who understands the subject must review the meaning.

Explicit human approval is required for policies, security or access procedures, financial or HR rules, contractual material, production recovery procedures, and similar consequential instructions. Public pages must also pass security and personal-data review.

After approval, merge the canonical change. The hosting system must then build the site from main. This repository does not currently define the hosting workflow, so the update is published only when the new build is live and the page shows the expected review date.

What the update changes

A successful publication updates one source and every way of using it:

the canonical documentation page;
sidebar navigation and tenant-scoped documentation search;
/llms.txt and the agent-readable document when ai_index is enabled;
the review date and provenance available to readers and the Datastat agent.

For the reader flow, continue to Find documentation. For answer behavior, read How the agent answers.