Skip to content

docs: move the agents notes to agents.md - #209

Merged
Exeloo merged 5 commits into
mainfrom
feat/agents-documentation
Nov 7, 2026
Merged

Exeloo merged 5 commits into
mainfrom
feat/agents-documentation

Conversation

@hvrp3r

@hvrp3r hvrp3r commented Oct 23, 2026 •

Copy link
Copy Markdown
Member

What does this PR do?

No linked issue.

Moves the agent instructions from CLAUDE.md to AGENTS.md, the file most AI coding agents read. CLAUDE.md now only imports it (@AGENTS.md), so Claude Code reads the same text and there is one copy to maintain.

AGENTS.md is the content of main's CLAUDE.md, with one change: the commit rule now says "No Co-Authored-By line" instead of asking for one.

How do you test this PR?

  • diff <(git show origin/main:CLAUDE.md) AGENTS.md shows only the Co-Authored-By line.
  • pnpm exec commitlint --from origin/main --to HEAD passes.
  • The pre-push hook (pnpm lint, pnpm typecheck, pnpm test:unit) passed.

Merge danger

None: docs only. Tools that read CLAUDE.md get the same text through the import.

Follow-up issues

None.

Quality gate

Lane reviewers on the first version, then two rounds of re-review on the fix commits.

Lane Result
Docs This PR is the docs
Correctness Pass: every fact checked against main; review findings fixed
Performance N/A: docs only
Accessibility N/A: no UI change
Security Pass: no secrets, no new permissions
Style Pass: Prettier, commitlint, no Co-Authored-By

@hvrp3r hvrp3r self-assigned this Oct 23, 2026
@Exeloo

Exeloo commented Nov 7, 2026

Copy link
Copy Markdown
Member

Review: Close

This PR duplicates the existing CLAUDE.md, and documents the old editor.

  • Duplicate: main already has a 312-line CLAUDE.md for the v2 editor. Adding AGENTS.md next to it would give two contradictory instruction sets: tools that read AGENTS.md would get the content below, while Claude Code reads CLAUDE.md.
  • Documents v1: this branch's parent commit is 3d55cae (2026-08-21), before the v2 rewrite (feat: rewrite v2 #206).
    • It describes the v1 layout (src/lib/client, src/lib/server, src/routes/actions, …), UnoCSS, Paraglide, messages/, the PUBLIC_MODE OFFLINE/ONLINE modes, e2e/demo.test.ts and pre-release.yml.
    • None of these exist on main, which is now a monorepo with apps/editor, packages/*, plugins/* and tooling/.
  • Deploys on merge: merging this redeploys the editor.

If cross-tool support is wanted: the smallest correct change is to rename CLAUDE.md to AGENTS.md and add a one-line CLAUDE.md containing @AGENTS.md. That needs its own PR.

Replace the v1 AGENTS.md with the current CLAUDE.md content, so every
agent reads one set of notes. CLAUDE.md now only imports AGENTS.md.
The team's commit rule is no Co-Authored-By line in any NanoForge repo.
@Exeloo Exeloo changed the title Feat/agents documentation docs: move the agents notes to agents.md Nov 7, 2026
@Exeloo
Exeloo merged commit ef47080 into main Nov 7, 2026
10 of 11 checks passed
@Exeloo
Exeloo deleted the feat/agents-documentation branch November 7, 2026 12:25
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.

2 participants