Skip to content

docs: add agents documentation - #451

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.

Adds AGENTS.md, the instructions AI coding agents read in this repo, and a CLAUDE.md that only imports it (@AGENTS.md), so Claude Code reads the same file.

AGENTS.md covers:

  • the layout: packages/*, modules/* (ecs in C++/WASM, graphics, input, network, ...), utils/*, e2e/, example/;
  • each package's name, dependencies, optional peers and exports;
  • the commands: build, lint, unit and e2e tests, pnpm run docs (typedoc; pnpm docs runs pnpm's own command), nightly.sh;
  • what needs Emscripten (build and test of modules/ecs, not install);
  • the conventions: dual ESM/CJS for packages/* and modules/*, changelogs, and releases through the actions v3 Release PR workflow (agents never run release).

How do you test this PR?

Docs only. Each claim was checked against main, after merging main into the branch: package manifests, scripts, .github/nanoforge.json, workflows and CONTRIBUTING.md. pnpm exec prettier --check AGENTS.md CLAUDE.md passes. The pre-push hook (build, lint, unit and e2e tests) passed.

Merge danger

None: two docs files, no package released.

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
@hvrp3r
hvrp3r requested a review from Exeloo as a code owner October 23, 2026 12:44
@Exeloo

Exeloo commented Nov 7, 2026

Copy link
Copy Markdown
Member

Review: Changes needed

This branch is 10 commits behind main, and the AGENTS.md describes the repo as it was before those commits. The repo's own AGENTS.md wins over other agent docs, so stale content here misleads agents.

Out of date against main (08f151f):

Minor:

  • The commit type is feat: for a docs-only change, so it probably triggers a minor release bump. Prefer docs:.
  • The PR description calls this "Claude Code context". Claude Code reads CLAUDE.md, so check that it picks up AGENTS.md. If it doesn't, add a one-line CLAUDE.md containing @AGENTS.md.

Checked: pnpm 12, Node 26, the modules/ecs scripts (build:wasm, test:unit, clean), the package names and the graphics-2d/network dependency edges are all correct.

Suggested fix: rebase onto main and refresh the structure, docs and CI sections.

@Exeloo Exeloo changed the title feat: agents documentation docs: add agents documentation Nov 7, 2026
@Exeloo
Exeloo merged commit 8f2cd93 into main Nov 7, 2026
9 of 10 checks passed
@Exeloo
Exeloo deleted the feat/agents-documentation branch November 7, 2026 12:24
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