agentleFS
onyx-dot-apponyx-dot-app/onyx-foss/documentation/AGENTS.md

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. -…

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
  1. Very specific:

    Before you write or edit a page, read and follow .agents/skills/docs-writing/SKILL.md (repo root).

    line 5
  2. Very specific:

    Do not commit logos, icons, or developers/api_reference/openapi.json.

    line 8
  3. Very specific:

    Run python3 scripts/format_docs.py --write before you commit.

    line 10
  4. Very specific:

    Write for customers who self-host or use Onyx Cloud.

    line 14

≈ “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.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

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.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.
  • Run python3 scripts/format_docs.py --write before you commit. The format-docs pre-commit hook runs the --check form.
  • Production docs follow the latest stable release, not main. A docs fix for the current release must also land on its release/vX.Y branch.
  • 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.

Download now (ZIP)

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
What did you use it for? e.g. Reviewing pull requests in a Rails app

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.