onyx-foss / documentation
AGENTS.md320 starsChanged 8 days agoMITView on GitHub
documentation/ is the Onyx customer documentation (Mintlify, published at https://docs.onyx.app). - Before you write or edit a page, read and follow .agents/skills/docs-writing/SKILL.md (repo root). It covers the reader, the sources of truth in this repo, the prose rules (ASD-STE100), the Mintlify patterns, screenshots, and the checks to run. - Do not commit logos, icons, or developers/api_reference/openapi.json. scripts/generate.sh builds them from web/lib/opal and the backend. To add a logo or icon, add it to opal and map it in scripts/generated_assets.json. -…
Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 32,671 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository10 other files it gives its agents.
- AGENTS.mdAGENTS.md
- backend/AGENTS.mdAGENTS.md
- mobile/AGENTS.mdAGENTS.md
- web/AGENTS.mdAGENTS.md
- docs-writingSkill
- feature-mapSkill
- merge-dependabot-prsSkill
- onyx-craft-devSkill
- onyx-dev-stackSkill
- playwright-e2e-testsSkill
The file
We split this AGENTS.md into the rules it gives an agent
4 rules. About 0 are common, 0 are distinctive, and 4 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈0
Distinctive · estimate
This author's own choices. Worth a look.
4
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- could be automatic: a setting could enforce it
- Very specific: line 5
Before you write or edit a page, read and follow .agents/skills/docs-writing/SKILL.md (repo root).
- Very specific: line 8
Do not commit logos, icons, or developers/api_reference/openapi.json.
- Very specific: line 10
Run python3 scripts/format_docs.py --write before you commit.
- Very specific: line 14
Write for customers who self-host or use Onyx Cloud.
≈ “Common” is an estimate: at least 1 in 5 of the 41,581 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Onyx docs
documentation/ is the Onyx customer documentation (Mintlify, published at https://docs.onyx.app).
- Before you write or edit a page, read and follow
.agents/skills/docs-writing/SKILL.md(repo root). It covers the reader, the sources of truth in this repo, the prose rules (ASD-STE100), the Mintlify patterns, screenshots, and the checks to run. - Do not commit logos, icons, or
developers/api_reference/openapi.json.scripts/generate.shbuilds them fromweb/lib/opaland the backend. To add a logo or icon, add it to opal and map it inscripts/generated_assets.json. - Run
python3 scripts/format_docs.py --writebefore you commit. Theformat-docspre-commit hook runs the--checkform. - Production docs follow the latest stable release, not
main. A docs fix for the current release must also land on itsrelease/vX.Ybranch. - Write for customers who self-host or use Onyx Cloud. Do not document multi-tenant operations (tenant provisioning,
the control plane,
MULTI_TENANT-only code). Customers cannot use them.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

