Docs Sync

Local release gate for keeping API docs, settings docs, release stats, and examples aligned with source.

Run the Check

$ ./scripts/docs_sync_check.py

The checker reads local source checkouts only. It compares FastAPI routes, runtime settings sections, core release metadata, and public-safety patterns. It does not contact live hosts.

Source Inputs

Input	Purpose
`ANIMA_PUBLIC_ROOT/interface/web_server.py`	Canonical public web/API routes
`ANIMA_PUBLIC_ROOT/plugins/_template/`	Plugin conventions and template config
`ANIMA_CORE_ROOT/Cargo.toml`	Core version metadata
`index.html`, `docs/*.html`	Public website content

Change Note

Surface changed:
Source file(s):
User-visible docs affected:
Examples changed:
Public-safe redactions needed:
Live data operator must supply:

Rules

Update endpoint docs when FastAPI decorators change.
Update settings docs when runtime config keys change.
Update landing stats only from public source metadata or operator-supplied release data.
Use localhost endpoints and generic model keys in public examples.
Do not publish private IPs, tailnet/CGNAT addresses, origin hosts, local paths, model weight filenames, copied router score tables, prompts, or credentials.
Deployment remains operator-only.