agentleFS
Sign inStart free
playcanvasplaycanvas/developer-site/AGENTS.md

developer-site

AGENTS.md148 starsChanged 40 days agoMITView on GitHub

Documentation site for PlayCanvas built with Docusaurus 3.

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:

    Localization: When updating docs/, also update the corresponding file in i18n/ja/docusaurus-plugin-content-docs/current/

    line 23
  2. Very specific:

    FAQ: Do not edit docs/user-manual/editor/faq.md directly - it is auto-generated from faq/.

    line 24
  3. Distinctive:

    File operations: Use git mv and git rm for moving/deleting files to ensure proper version control tracking.

    line 25
  4. Very specific:

    LLM indexes: When you move, rename or remove a page, update any llms/ index that links it.

    line 26

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

Agent Guidelines for PlayCanvas Developer Site

Project Overview

Documentation site for PlayCanvas built with Docusaurus 3.

  • Language: Markdown/MDX
  • Framework: Docusaurus 3
  • License: MIT

Directory Structure

docs/           # English documentation (source of truth)
i18n/ja/        # Japanese translations
static/img/     # Images (mirrors docs/ structure)
faq/            # FAQ source files (auto-generates docs/user-manual/editor/faq.md)
llms/           # Hand-written llms.txt indexes for AI agents (mirrors their published paths)

Critical Rules

  1. Localization: When updating docs/, also update the corresponding file in i18n/ja/docusaurus-plugin-content-docs/current/
  2. FAQ: Do not edit docs/user-manual/editor/faq.md directly - it is auto-generated from faq/. Run npm run faq after editing FAQ source files.
  3. File operations: Use git mv and git rm for moving/deleting files to ensure proper version control tracking.
  4. LLM indexes: When you move, rename or remove a page, update any llms/ index that links it. A new top-level User Manual section must be added to the covers list of one index. npm test and CI builds fail until both hold (local builds only warn).

Commands

npm run start   # Development server
npm run build   # Production build (slow - several minutes, avoid unless necessary)
npm run lint    # Lint Markdown files
npm test        # Test the LLM file generation, including every llms/ index
npm run faq     # Regenerate FAQ page

Download now (ZIP)

  • 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 28,693 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 repositoryOne other file it gives its agents.

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.

Check your setup, free