Docs Maintenance

Documentation drift is part of the change, not a later cleanup.

Update Docs When These Change

Public research workflow: projects, branches, experiments, graph, timeline, file, or diff behavior.
CLI command behavior in onyx-agent.
Agent skill workflow or runner contract.
/api/v1 endpoint shape, auth, response envelopes, or OpenAPI output.
Auth, team roles, API key, profile, or login behavior.
GitHub App access, lazy project provisioning, repository access, or repository sync behavior.
projectPath, onyx/onyx.md, eval.sh, checks.sh, outbox, history, or sync semantics.
Install, release, or local development commands.

Topic	Source
Product architecture	`/Users/ted/onyx/onyx-research/AGENTS.md`, `README.md`, `CLAUDE.md`
CLI commands	`/Users/ted/onyx/onyx-research/packages/agent/src/main.ts`
Agent skill	`/Users/ted/onyx/onyx-research/packages/agent/skills/onyx/SKILL.md`
API contracts	`/Users/ted/onyx/onyx-research/packages/contracts/src`
Generated OpenAPI	`/Users/ted/onyx/onyx-research/packages/contracts/openapi/openapi.json`
Product UI flows	`/Users/ted/onyx/onyx-research/apps/web`

After changing contracts or route metadata:

cd /Users/ted/onyx/onyx-research/packages/contracts
bun run export:openapi

cd /Users/ted/onyx/docs
node scripts/sync-openapi.mjs

The landing site serves this Mintlify site from https://onyxresearch.ai/docs. Mintlify setup:

Vercel setup:

Keep rewrites in /Users/ted/onyx/onyx-research/apps/www/vercel.json.
Keep matching local-dev rewrites in /Users/ted/onyx/onyx-research/apps/www/next.config.mjs.
Keep the rewrite destination pointed at https://onyx-6c9b5c1a.mintlify.dev.
Keep landing-site docs links pointed at /docs so local development uses the local proxy.

Run the docs stale-content check before handoff:

rg "Onyx Eng[i]ne|onyxeng[i]ne|engine\\.onyx-robotics|train_mod[e]l|datas[e]t" /Users/ted/onyx/docs