Repository navigation
Project docs for agents: CLAUDE.md, AGENTS.md, DESIGN.md, SOUL.md - #196
Merged
Merged
Conversation
Adds the four project docs agents read first. Every command is copied from package.json, .github/workflows/test.yml, CONTRIBUTING.md, SKILL.md, brand/README.md or CHANGELOG.md; every purpose, audience, positioning and refusal line from README.md and CONTRIBUTING.md. SOUL.md has no Voice section: no source in the repo states one. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
Four new files at the repo root. Nothing else changes.
CLAUDE.md: what decklet is, build and run, test, ship and pointers. Commands come frompackage.jsonscripts,.github/workflows/test.yml, the START HERE block inSKILL.md,CONTRIBUTING.md(setup, rules, generated files, atomic PRs),brand/README.md,CHANGELOG.md(DECKLET_PROJECTS),ROADMAP.md("Release lockstep", step 1 only) anddocs/archify.md. The deploy line comes from the repo's GitHub Pages settings (legacy build frommain, path/) and the live URLs inREADME.md.AGENTS.md: one line pointing Codex atCLAUDE.md.DESIGN.md: decklet's own brand, not the client style kits. Palette, wordmark, marks, loader and regenerate commands come frombrand/README.md,PALETTEinbrand/build-logos.mjsand the colours inbrand/assets/*.svg. HUD, save button and touch rules come fromdocs/editor.md,README.mdandCHANGELOG.md.SOUL.md: purpose, audience and positioning closely paraphraseREADME.md(the lead, "Who it is for" and "How decklet compares"). Refusals come fromCONTRIBUTING.mdandREADME.md("Guarantees", "Bugs", the 0.9.0 history note).Why
Agents had no repo-level entry point for build, test and ship. They read those facts from SKILL.md, CONTRIBUTING.md and docs spread across the tree.
Gaps left visible
SOUL.mdhas no Voice section. No file in the repo states a voice for decklet, so none was written.ROADMAP.mdlists it under Later, so the sources disagree.Verification
npm testlocally: 696 tests, 455 pass, 3 skipped, 238 fail. Every failure isbrowserType.launch: Executable doesn't exist, because this machine has no Playwright 1.63 browsers installed. No test reads the new files. Thetestgate installs Chromium, WebKit and Firefox and runs the full suite.Post-merge
The first
testrun failed one Firefox timing test (test/autosave.test.mjs:143, two windows). The rerun passed, and the PR was squash-merged as a186a78.maincarries all four files.🤖 Generated with Claude Code