Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
- A pattern games must follow that types and devtools cannot catch becomes a rule in `packages/oxlint-plugin`, tested with real code, whose message says what goes wrong and the API to use instead.

## Docs
- A game's agent sees only what npm ships: `src` JSDoc, each `README.md` and `CHANGELOG.md`, `packages/core/SETUP.md` (one-time setup), and the skills in `packages/core/skills`: `ritmo` (every change, with playbooks), `ritmo-prototype` (while a game is a prototype), `ritmo-onboarding` (when strangers are about to play it), and `ritmo-polish` (when a finished game gets its feel, feedback, and UI polished). Guidance a game needs goes there, never in a repo-only file, and says nothing a JSDoc, README, or lint message already says. `packages/core/PROTOTYPE.md`, `packages/core/ONBOARDING.md`, `packages/core/POLISH.md`, `packages/core/FX.md`, and `packages/core/PIXEL-ART.md` (repo-only) quote the source behind each rule of `ritmo-prototype`, `ritmo-onboarding`, `ritmo-polish`, `ritmo-fx`, and `ritmo-pixel-art`; a change to any of the five skills updates its file, and a rule with no source does not go in.
- A game's agent sees only what npm ships: `src` JSDoc, each `README.md` and `CHANGELOG.md`, `packages/core/SETUP.md` (one-time setup), and the skills in `packages/core/skills`: `ritmo` (every change, with playbooks), `ritmo-prototype` (while a game is a prototype), `ritmo-onboarding` (when strangers are about to play it), and `ritmo-polish` (when a finished game gets its feel, feedback, and UI polished). Guidance a game needs goes there, never in a repo-only file, and says nothing a JSDoc, README, or lint message already says. `packages/core/PROTOTYPE.md`, `packages/core/ONBOARDING.md`, `packages/core/POLISH.md`, `packages/core/FX.md`, and `packages/core/PIXEL-ART.md` (repo-only) quote the source behind each rule of `ritmo-prototype`, `ritmo-onboarding`, `ritmo-polish`, `ritmo-fx`, and `ritmo-pixel-art`; a change to any of the five skills updates its file, and a rule with no source does not go in. `packages/core/genres/` (repo-only) holds sourced research on one kind of game's craft, in the same format, for a later skill rule to draw from; it is not guidance a game sees.
- Humans read the root `README.md` and the website (`website/`, see its README): a guide with running demos and snippets compiled by Twoslash, never an API reference. A change that breaks a website snippet or demo fixes it in the same change; the website build in CI fails until it does.
- Package READMEs link other packages' docs by GitHub URL (`https://github.com/typeonce-dev/ritmo/blob/main/packages/<name>/README.md`), never by relative path or into `integration/`.

Expand Down
Loading
Loading