agentleFS
AlexaysAlexays/Lilo/docs-site/AGENTS.md

Lilo / docs-site

AGENTS.md58 starsChanged 10 days agoMITView on GitHub

These rules apply to docs-site/, the user documentation at docs.getlilo.app, alongside the repository's AGENTS.md. Read README.md for the layout and deployment. The site is built with Blume, pinned in package.json; its full documentation ships in node_modules/blume/docs/ and its agent skill in node_modules/blume/skills/blume/SKILL.md. Read them for the version installed here, not from memory. Run commands from the repository root through Make: make docs-check docs-test for any change here (validation, translation gate, build, tests and blume audit), `mak

  • 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 33,315 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 repository6 other files it gives its agents.

The file

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:

    Every statement is true of the current app and found in its source: shortcuts in Lilo/App/KeyboardShortcuts.swift, menu and setting names …

    line 9
  2. Distinctive:

    Use Blume's built-in components with no imports.

    line 11
  3. Very specific:

    No real user data in text or examples: example.com hosts and made-up names.

    line 12
  4. Very specific:

    After the agent, scripts/typography.mjs restores French spacing (no-break spaces before : and inside « », narrow ones before .

    line 22

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

Documentation site

These rules apply to docs-site/, the user documentation at docs.getlilo.app, alongside the repository's AGENTS.md. Read README.md for the layout and deployment. The site is built with Blume, pinned in package.json; its full documentation ships in node_modules/blume/docs/ and its agent skill in node_modules/blume/skills/blume/SKILL.md. Read them for the version installed here, not from memory.

Content

  • Pages are Markdown or MDX under content/, English at the root and French in content/fr/ with the same tree. Organize by what the reader is trying to do: start/ (tutorials), guides/ (how-to), reference/, about/ (explanation).
  • Every page has a title and a description of 110 to 160 characters. A page's URL comes from its file name, and its place in the sidebar from sidebar.order; folder titles and order live in each folder's meta.ts. URLs are stable: never rename or move a page without the owner's agreement.
  • Every statement is true of the current app and found in its source: shortcuts in Lilo/App/KeyboardShortcuts.swift, menu and setting names as lilo-ui/src/lib/i18n/locales/en.json and fr.json spell them, terms as the glossary in docs/ARCHITECTURE.md defines them.
  • Link other pages root-relative in their English form (/guides/split-view); Blume moves them into the reader's locale. URLs have no trailing slash.
  • Use Blume's built-in components with no imports; add no custom components or layout overrides.
  • No real user data in text or examples: example.com hosts and made-up names. No screenshots.

Generated reference

  • scripts/generate.mjs writes the partials under content/reference/_generated/ (and the French shortcut and settings tables) from the app's sources before every Blume command. They are git-ignored build outputs: change the source they come from, never the partial. A reference page includes its partial with <include>./_generated/<name>.md</include>, which resolves to the French partial on the French page.
  • The generator must be deterministic (no dates, stable order) and fail loudly on input it does not understand.

Translation

  • French is produced by make docs-translate, which runs blume translate with Claude Code, then review the diff against the French interface strings and commit the pages, partials and blume.translations.json together. Never edit the ledger by hand.
  • After the agent, scripts/typography.mjs restores French spacing (no-break spaces before : and inside « », narrow ones before ; ? !) and straight apostrophes, which every retranslation loses.
  • Interface labels stay a manual check: the translating agent cannot read the repository, so it guesses names it does not know, and a retranslation can revert an earlier hand correction even in a sentence whose English did not change. In the diff, compare every bold label, menu path and quoted message with lilo-ui/src/lib/i18n/locales/fr.json and fix the French file by hand; hand edits keep the page current in the ledger.
  • make docs-check fails when a French page is missing, out of date or absent from the ledger, when the ledger is missing or broken, and when a translated reference partial is missing; a stale translated partial only warns (a ::warning:: annotation in GitHub Actions).

Headers and deployment

  • scripts/headers.mjs prepends the Content-Security-Policy and security headers to the _headers file Blume writes, hashing each inline script. Do not add public/_headers: it would replace Blume's rules.
  • The site deploys as its own Cloudflare Worker with static assets (wrangler.toml). Only make docs-deploy-check (a dry run) is part of the work; deploying is the owner's.

Verification

Run commands from the repository root through Make: make docs-check docs-test for any change here (validation, translation gate, build, tests and blume audit), make docs-preview to see the build with its real headers. For layout or theme changes, check both languages at desktop and 390 px width, light and dark, keyboard focus, Reduce Motion, and the browser console for CSP violations.

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.