daromsartofdaromsartof/daroms-speed-site/docs/agents.md

daroms-speed-site

AGENTS.md0 starsChanged 2 days agoMITView on GitHub

The operating manual for an agent (Claude Code or any coding agent): what to read, how to start a site, the contract every site follows and the checks to run before saying done. - Every page of the docs site has a raw Markdown twin: append .md to the page name (getting-started.md, agents.md, catalog.md). - llms.txt lists every page with a one-line summary; llms-full.txt is the whole documentation and the catalog in one file. Load llms-full.txt once instead of crawling…

Reads credentials

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 31,439 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 repository4 other files it gives its agents.
- template/AGENTS.mdAGENTS.md
- template/CLAUDE.mdCLAUDE.md
- docs/llms-full.txtllms.txt
- docs/llms.txtllms.txt

The file

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

Very specific:
Every page of the docs site has a raw Markdown twin: append .md to the page name (getting-started.md, agents.md, catalog.md).
line 7
Very specific:
Check: pnpm dss doctor (theme, pages, placeholders, credit, types, lint), pnpm test, pnpm build.
line 47
Distinctive:
No hard-coded copy in JSX, no em dashes, no generated-copy cliches, no emoji.
line 56

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

For AI agents

The operating manual for an agent (Claude Code or any coding agent): what to read, how to start a site, the contract every site follows and the checks to run before saying done.

Read this documentation as Markdown

Every page of the docs site has a raw Markdown twin: append .md to the page name (getting-started.md, agents.md, catalog.md).
llms.txt lists every page with a one-line summary; llms-full.txt is the whole documentation and the catalog in one file. Load llms-full.txt once instead of crawling pages.

Inside a generated site

CLAUDE.md loads the kernel (core/_ai/CLAUDE.core.md, under 60 lines) and the rules digest. Detailed rules load by file path from .claude/rules/.
site.spec.md is the brief and the single source of facts; its Journal records decisions, Open facts what is still unknown.
core/CATALOG.md lists tokens, components, sections, modules, archetypes and package APIs. Never read core sources.

Start a site

npx @daromsart/daroms-speed-site new <slug> --preset vitrine --industry "<industry>" --mood "<two or three words>"
cd <slug> && pnpm dev

Then /dss-site <one-sentence idea> in Claude Code (a checkpoint after each step), or headless for a batch: pnpm dss factory run ./briefs --out ./sites --agent (decisions go to the Journal, the run stops before deploy).

The contract

What	Where
Every visible word	`content/<page>.ts`, typed `as const`
Pages	`app/**/page.tsx`: metadata and sections only
Sections	`components/sections/*.tsx`: owned code, a `// dss-section:` stamp and a `@catalog` line
Look and feel	`design.dna.ts`, then `pnpm dss theme`; generated theme files are never edited
Pages, modules, deploy, CSP	`site.manifest.ts`, rewritten by the CLI
Forms and mutations	`server/actions/*` through `safeAction`
Unknown facts	`[placeholders]` plus `site.spec.md > Open facts`; never invent testimonials, numbers or legal data
Studio credit	the footer link to https://daromsart.xyz/ (`content/site.ts > footer.credit`) stays on every site

Commands

Generate before writing: pnpm dss g page|section, pnpm dss add section <id>, pnpm dss module add <slug>, pnpm dss dna roll, pnpm dss db init.
Check: pnpm dss doctor (theme, pages, placeholders, credit, types, lint), pnpm test, pnpm build.
Ship: pnpm dss deploy (noindexed preview), pnpm dss deploy --prod (needs the real domain and doctor --strict), then pnpm dss cost.

Guard rails

Hooks refuse a write before it lands and say why in one line: fix the cause, never work around it.

DNA token classes only: no hex or rgb, no default Tailwind palette, no inline style.
No hard-coded copy in JSX, no em dashes, no generated-copy cliches, no emoji.
No any, files under 250 lines, Next.js 16 APIs (proxy.ts, async params, revalidateTag(tag, profile)).
Secrets stay server-side; .env* and .dev.vars are never read.
A reasoned exception takes a dss-ignore comment on the line.

Headless runs

A new folder is not a trusted workspace: Claude Code ignores the project's permissions.allow. factory run passes the rules on the command line; for a manual claude -p, pass --allowedTools with the rules from .claude/settings.json.
Each shell command must match an allow rule: prefer the Read and Grep tools to compound shell pipelines.
Done means verified: doctor, tests and build pass, and the result names what could not be checked.

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.

Check your setup, free