agentleFS
Sign inStart free
SuperJJ007SuperJJ007/papermachine/website/AGENTS.md

papermachine / website

AGENTS.md59 starsChanged 50 days agoMITView on GitHub

Follow the root instructions, the documentation standard, and the documentation workflow. website/ owns only VitePress configuration, presentation assets, and the publication manifest. This file is the only maintained Markdown file in this subtree. Keep canonical prose and generated catalogs in their owning docs/ tier, then expose selected pages through docs.ts. Never add locale, route, API, or copied documentation trees such as website/zh-CN/, website/en/, or website/api/. The projector writes disposable Markdown to the ignored website/.generated/ directory. Never edit or commit .generated/,…

We split this AGENTS.md into the rules it gives an agent

3 rules. About 0 are common, 1 is distinctive, and 2 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Follow the root instructions, the documentation standard, and the documentation workflow.

    line 3
  2. Very specific:

    Keep canonical prose and generated catalogs in their owning docs/ tier, then expose selected pages through docs.ts.

    line 9
  3. Very specific:

    Run pnpm docs:check after changing this subtree.

    line 17

≈ “Common” is an estimate: at least 1 in 5 of the 36,368 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

AGENTS.md — Documentation website adapter

Follow the root instructions, the documentation standard, and the documentation workflow.

Keep documentation content out of this tree

website/ owns only VitePress configuration, presentation assets, and the publication manifest. This file is the only maintained Markdown file in this subtree.

Keep canonical prose and generated catalogs in their owning docs/ tier, then expose selected pages through docs.ts. Never add locale, route, API, or copied documentation trees such as website/zh-CN/, website/en/, or website/api/.

The projector writes disposable Markdown to the ignored website/.generated/ directory. Never edit or commit .generated/, .cache/, or .dist/.

Production builds remove the configured output directory after VitePress resolves the site configuration and before it writes files. They reject output whose lexical path or nearest existing parent escapes the real site root, and unlink a link-shaped output instead of traversing its target. Raw-Markdown emission then treats files produced by that build as occupied and never overwrites them.

The build also emits each route's raw-Markdown twin (with a parent-level alias per index route) and a root llms.txt index into .dist/, so a page's URL, minus any trailing slash, plus .md serves it as plain Markdown. Both derive from the publication manifest at build time; neither is ever a file in this tree.

Run pnpm docs:check after changing this subtree; the gate rejects additional non-ignored Markdown under website/.

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.

Reviews can't be read right now.

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.

Check your setup, free