Skip to content

docs: add AGENTS.md and CLAUDE.md for coding agents - #2

Merged
napalm255 merged 2 commits into
mainfrom
docs/agents-md
Sep 24, 2026
Merged

napalm255 merged 2 commits into
mainfrom
docs/agents-md

Conversation

@napalm255

@napalm255 napalm255 commented Sep 24, 2026 •

Copy link
Copy Markdown
Contributor

Why

Agents working on the site need a few rules that aren't visible in the code. Without them it's easy to publish something by mistake, break a sibling project's docs path, or add a project in one place but not the other two.

What

A new AGENTS.md covering:

  • What is published: only docs/, via branch deploy (main, /docs). The project paths belong to the project repos.
  • Hard constraints: no framework, build step or JavaScript on the page; no third-party requests; WCAG 2.2 AA; must fit a 360px phone; reduced motion respected. It notes which of these the tests enforce.
  • Design rules: the colour tokens; why .night stays dark; the gradient is never used behind text; logical CSS properties.
  • Commands: the just recipes.
  • Adding a project: the three places to update, including Ghost-Assembly/.github.
  • Images: everything is derived by just assets.
  • Change workflow: branch, PR, squash-merge after ci passes.

Also adds CLAUDE.md, which only contains @AGENTS.md. Claude Code reads it, so there is still a single source of agent guidance.

Verification

just ci locally: prettier, actionlint and zizmor are clean; 20 Playwright tests passed; osv-scanner and gitleaks report no findings.

🤖 Generated with Claude Code

https://claude.ai/code/session_0131wf4z8YVdVbMmQqVnhzzU

napalm255 and others added 2 commits September 24, 2026 15:38
Records the rules that are not visible from the code: only docs/ is
published, project paths are owned by other repos, the page carries no
JavaScript and makes no third-party requests, and a project must be
updated in three places, one of them in the .github repository.

Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
Claude-Session: https://claude.ai/code/session_0131wf4z8YVdVbMmQqVnhzzU
Claude Code reads CLAUDE.md; importing AGENTS.md keeps a single source of
agent guidance for every tool.

Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
Claude-Session: https://claude.ai/code/session_0131wf4z8YVdVbMmQqVnhzzU
@napalm255 napalm255 changed the title docs: add AGENTS.md for coding agents docs: add AGENTS.md and CLAUDE.md for coding agents Sep 24, 2026
@napalm255
napalm255 merged commit 133f7e8 into main Sep 24, 2026
1 check passed
@napalm255
napalm255 deleted the docs/agents-md branch September 24, 2026 19:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant