agentleFS
Sign inStart free
MicrosoftKnown publishermicrosoft/rayfin/docs/site/AGENTS.md

rayfin / site

AGENTS.md646 starsChanged 24 days agoMITView on GitHub

Scope: Docusaurus site under docs/site for Contributors. Use the Rush docs subspace. - Install deps: rush update --subspace docs - Dev server: cd docs/site && rushx start - Build: cd docs/site && rushx build or rush build --to docs-site - Serve static: cd docs/site && rushx serve (pass additional Docusaurus flags after --) - Lint markdown: rush docs:lint - Always run rushx commands from docs/site. - If a command fails, capture the full terminal output and confirm pwd before trying…

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

4 rules. About 0 are common, 1 is distinctive, and 3 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.

  • 3

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Use the Rush docs subspace.

    line 4
  2. Very specific:

    Always run rushx commands from docs/site.

    line 17
  3. Very specific:

    If a command fails, capture the full terminal output and confirm pwd before trying anything else.

    line 18
  4. Distinctive:

    If the recommended command does not work, pause and ask for help rather than trying random variants.

    line 20

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

Docs Site AGENTS

Scope: Docusaurus site under docs/site for Contributors. Use the Rush docs subspace.

Commands

  • Install deps: rush update --subspace docs
  • Dev server: cd docs/site && rushx start
  • Build: cd docs/site && rushx build or rush build --to docs-site
  • Serve static: cd docs/site && rushx serve (pass additional Docusaurus flags after --)
  • Lint markdown: rush docs:lint

Guardrails

  • Always run rushx commands from docs/site.
  • If a command fails, capture the full terminal output and confirm pwd before trying anything else.
  • If the recommended command does not work, pause and ask for help rather than trying random variants.

Content Sources

The site renders two distinct kinds of content through a unified SDK Reference sidebar plus a separate Guide section:

  • Handwritten package docs (kind: 'guide' and kind: 'reference' with hand-written assets): discovered at config-load time by @microsoft/rayfin-docs walking the workspace and reading each package's rayfinDocs manifest. Source of truth lives in each package's assets/docs/ folder.
  • Generated TypeScript SDK API reference: TypeDoc emits per-module trees into packages/docgen/dist/ts-sdk/@microsoft/<module>/. docusaurus.config.ts mirrors them into docs/site/.ts-sdk-unified/ at config-load time and renders them through one Docusaurus docs plugin instance. Edit-this-page links are suppressed for TypeDoc-backed modules because the markdown is generated.

Conventions

  • Generated site output: docs/site/build/
  • Cache invalidation: docs-site's devDependencies include @rayfin/docgen (which transitively pulls in every SDK package whose API reference is generated) plus @microsoft/rayfin-guide (handwritten content not covered by docgen). Rush's build cache therefore invalidates correctly when any documented package source changes.
  • TS SDK route: /docs/ts-sdk/<rayfin-module> (all modules served by a single Docusaurus docs plugin against .ts-sdk-unified/).
  • Shared landing route: docusaurus.config.ts computes tsApiLandingPath once and surfaces it via siteConfig.customFields; the navbar and the homepage CTAs read from the same value to prevent drift.
  • Config: onBrokenLinks: 'ignore'; fix broken links in package-owned docs at the source package.
  • Dependencies: from docs/site, run rush add -p <pkg> --dev.

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