mirror of
https://github.com/prdlk/dotfiles.git
synced 2026-11-02 11:32:42 +00:00
chs: re-add drifted files
This commit is contained in:
1 parent
fc4837392a
commit
063e9839ce
50 files changed
+516
-482
No files matched your search
@@ -194,9 +194,9 @@
|
|||||||
"sourceType": "github",
|
"sourceType": "github",
|
||||||
"sourceUrl": "https://github.com/vercel-labs/json-render.git",
|
"sourceUrl": "https://github.com/vercel-labs/json-render.git",
|
||||||
"skillPath": "skills/vue/SKILL.md",
|
"skillPath": "skills/vue/SKILL.md",
|
||||||
"skillFolderHash": "36ac0134b49c61add24b7a3800f06429de5a5936",
|
"skillFolderHash": "fd64dd02c9a2e3df5c1f4cbb1731f68a694a5880",
|
||||||
"installedAt": "2026-03-13T21:58:14.274Z",
|
"installedAt": "2026-03-13T21:58:14.274Z",
|
||||||
"updatedAt": "2026-08-14T01:06:51.373Z"
|
"updatedAt": "2026-08-19T20:07:43.586Z"
|
||||||
},
|
},
|
||||||
"svelte": {
|
"svelte": {
|
||||||
"source": "vercel-labs/json-render",
|
"source": "vercel-labs/json-render",
|
||||||
@@ -302,54 +302,54 @@
|
|||||||
"sourceType": "github",
|
"sourceType": "github",
|
||||||
"sourceUrl": "https://github.com/mattpocock/skills.git",
|
"sourceUrl": "https://github.com/mattpocock/skills.git",
|
||||||
"skillPath": "skills/engineering/improve-codebase-architecture/SKILL.md",
|
"skillPath": "skills/engineering/improve-codebase-architecture/SKILL.md",
|
||||||
"skillFolderHash": "db546af0f3419a8bd261a83708d4cb33d2a915cd",
|
"skillFolderHash": "3d35cd438f4067b03c8b3792e038960e4ac11526",
|
||||||
"installedAt": "2026-05-11T17:38:14.404Z",
|
"installedAt": "2026-05-11T17:38:14.404Z",
|
||||||
"updatedAt": "2026-08-16T19:29:32.588Z"
|
"updatedAt": "2026-08-19T20:07:44.416Z"
|
||||||
},
|
},
|
||||||
"prototype": {
|
"prototype": {
|
||||||
"source": "mattpocock/skills",
|
"source": "mattpocock/skills",
|
||||||
"sourceType": "github",
|
"sourceType": "github",
|
||||||
"sourceUrl": "https://github.com/mattpocock/skills.git",
|
"sourceUrl": "https://github.com/mattpocock/skills.git",
|
||||||
"skillPath": "skills/engineering/prototype/SKILL.md",
|
"skillPath": "skills/engineering/prototype/SKILL.md",
|
||||||
"skillFolderHash": "57569dda16077a016b8fb82494dbf9f6430d7cc4",
|
"skillFolderHash": "e41d92e171f074a2b6887d8f6faca4a15c83d1ca",
|
||||||
"installedAt": "2026-05-11T17:38:14.405Z",
|
"installedAt": "2026-05-11T17:38:14.405Z",
|
||||||
"updatedAt": "2026-08-11T19:45:04.693Z"
|
"updatedAt": "2026-08-19T20:07:45.327Z"
|
||||||
},
|
},
|
||||||
"setup-matt-pocock-skills": {
|
"setup-matt-pocock-skills": {
|
||||||
"source": "mattpocock/skills",
|
"source": "mattpocock/skills",
|
||||||
"sourceType": "github",
|
"sourceType": "github",
|
||||||
"sourceUrl": "https://github.com/mattpocock/skills.git",
|
"sourceUrl": "https://github.com/mattpocock/skills.git",
|
||||||
"skillPath": "skills/engineering/setup-matt-pocock-skills/SKILL.md",
|
"skillPath": "skills/engineering/setup-matt-pocock-skills/SKILL.md",
|
||||||
"skillFolderHash": "abf20c04a4aa8a37ff20aa7286f28857150f8b8d",
|
"skillFolderHash": "ec07f82df54064d01aa1648670e81da41e2cbdc2",
|
||||||
"installedAt": "2026-05-11T17:38:14.405Z",
|
"installedAt": "2026-05-11T17:38:14.405Z",
|
||||||
"updatedAt": "2026-08-11T19:45:05.261Z"
|
"updatedAt": "2026-08-19T20:07:45.909Z"
|
||||||
},
|
},
|
||||||
"tdd": {
|
"tdd": {
|
||||||
"source": "mattpocock/skills",
|
"source": "mattpocock/skills",
|
||||||
"sourceType": "github",
|
"sourceType": "github",
|
||||||
"sourceUrl": "https://github.com/mattpocock/skills.git",
|
"sourceUrl": "https://github.com/mattpocock/skills.git",
|
||||||
"skillPath": "skills/engineering/tdd/SKILL.md",
|
"skillPath": "skills/engineering/tdd/SKILL.md",
|
||||||
"skillFolderHash": "8c098cfbaf956292d413d1140f5ee68f70dcc9ee",
|
"skillFolderHash": "79288be15c67b849f22b6572056601090fd20913",
|
||||||
"installedAt": "2026-05-11T17:38:14.405Z",
|
"installedAt": "2026-05-11T17:38:14.405Z",
|
||||||
"updatedAt": "2026-08-16T19:29:33.104Z"
|
"updatedAt": "2026-08-19T20:07:46.470Z"
|
||||||
},
|
},
|
||||||
"triage": {
|
"triage": {
|
||||||
"source": "mattpocock/skills",
|
"source": "mattpocock/skills",
|
||||||
"sourceType": "github",
|
"sourceType": "github",
|
||||||
"sourceUrl": "https://github.com/mattpocock/skills.git",
|
"sourceUrl": "https://github.com/mattpocock/skills.git",
|
||||||
"skillPath": "skills/engineering/triage/SKILL.md",
|
"skillPath": "skills/engineering/triage/SKILL.md",
|
||||||
"skillFolderHash": "6e908c1423a1b409e85066a6efbbbbc63b063e2b",
|
"skillFolderHash": "95fa21bf236993cd9af25bd3670476c17fdb95a4",
|
||||||
"installedAt": "2026-05-11T17:38:14.406Z",
|
"installedAt": "2026-05-11T17:38:14.406Z",
|
||||||
"updatedAt": "2026-08-16T19:29:33.706Z"
|
"updatedAt": "2026-08-19T20:07:47.172Z"
|
||||||
},
|
},
|
||||||
"remix": {
|
"remix": {
|
||||||
"source": "remix-run/remix",
|
"source": "remix-run/remix",
|
||||||
"sourceType": "github",
|
"sourceType": "github",
|
||||||
"sourceUrl": "https://github.com/remix-run/remix.git",
|
"sourceUrl": "https://github.com/remix-run/remix.git",
|
||||||
"skillPath": ".agents/skills/remix/SKILL.md",
|
"skillPath": ".agents/skills/remix/SKILL.md",
|
||||||
"skillFolderHash": "f4a5b113c626d7b17834af0bad6bfdb6b41cbf0f",
|
"skillFolderHash": "a4d5d8d8f74e4e67d44e5d9b90011ebc5f4bc1ac",
|
||||||
"installedAt": "2026-05-23T19:11:24.642Z",
|
"installedAt": "2026-05-23T19:11:24.642Z",
|
||||||
"updatedAt": "2026-08-15T20:19:36.456Z"
|
"updatedAt": "2026-08-19T20:08:01.258Z"
|
||||||
},
|
},
|
||||||
"typescript-expert": {
|
"typescript-expert": {
|
||||||
"source": "remix-run/remix",
|
"source": "remix-run/remix",
|
||||||
@@ -482,27 +482,27 @@
|
|||||||
"sourceType": "github",
|
"sourceType": "github",
|
||||||
"sourceUrl": "https://github.com/mattpocock/skills.git",
|
"sourceUrl": "https://github.com/mattpocock/skills.git",
|
||||||
"skillPath": "skills/engineering/codebase-design/SKILL.md",
|
"skillPath": "skills/engineering/codebase-design/SKILL.md",
|
||||||
"skillFolderHash": "20b7cd1dd1fe5b0bd37ba72649f3a29375574b5b",
|
"skillFolderHash": "344e3efc88ee60663b2e989555c2efdb548fbd42",
|
||||||
"installedAt": "2026-06-27T19:37:25.602Z",
|
"installedAt": "2026-06-27T19:37:25.602Z",
|
||||||
"updatedAt": "2026-08-11T19:45:06.991Z"
|
"updatedAt": "2026-08-19T20:07:47.794Z"
|
||||||
},
|
},
|
||||||
"diagnosing-bugs": {
|
"diagnosing-bugs": {
|
||||||
"source": "mattpocock/skills",
|
"source": "mattpocock/skills",
|
||||||
"sourceType": "github",
|
"sourceType": "github",
|
||||||
"sourceUrl": "https://github.com/mattpocock/skills.git",
|
"sourceUrl": "https://github.com/mattpocock/skills.git",
|
||||||
"skillPath": "skills/engineering/diagnosing-bugs/SKILL.md",
|
"skillPath": "skills/engineering/diagnosing-bugs/SKILL.md",
|
||||||
"skillFolderHash": "8599c0f6e2bfce70b85973d3be6707426bc8e83f",
|
"skillFolderHash": "99bd56983e42bc752c52da67f1112e4121781cd1",
|
||||||
"installedAt": "2026-06-27T19:37:25.603Z",
|
"installedAt": "2026-06-27T19:37:25.603Z",
|
||||||
"updatedAt": "2026-08-16T19:29:34.352Z"
|
"updatedAt": "2026-08-19T20:07:48.691Z"
|
||||||
},
|
},
|
||||||
"domain-modeling": {
|
"domain-modeling": {
|
||||||
"source": "mattpocock/skills",
|
"source": "mattpocock/skills",
|
||||||
"sourceType": "github",
|
"sourceType": "github",
|
||||||
"sourceUrl": "https://github.com/mattpocock/skills.git",
|
"sourceUrl": "https://github.com/mattpocock/skills.git",
|
||||||
"skillPath": "skills/engineering/domain-modeling/SKILL.md",
|
"skillPath": "skills/engineering/domain-modeling/SKILL.md",
|
||||||
"skillFolderHash": "05c3244ec75b7548bbc2b635b0624bb9f70369c3",
|
"skillFolderHash": "388c9822641805ca2dcd5038e68a1d5282437ee5",
|
||||||
"installedAt": "2026-06-27T19:37:25.604Z",
|
"installedAt": "2026-06-27T19:37:25.604Z",
|
||||||
"updatedAt": "2026-08-14T01:06:53.915Z"
|
"updatedAt": "2026-08-19T20:07:49.670Z"
|
||||||
},
|
},
|
||||||
"grilling": {
|
"grilling": {
|
||||||
"source": "mattpocock/skills",
|
"source": "mattpocock/skills",
|
||||||
@@ -518,18 +518,18 @@
|
|||||||
"sourceType": "github",
|
"sourceType": "github",
|
||||||
"sourceUrl": "https://github.com/mattpocock/skills.git",
|
"sourceUrl": "https://github.com/mattpocock/skills.git",
|
||||||
"skillPath": "skills/productivity/teach/SKILL.md",
|
"skillPath": "skills/productivity/teach/SKILL.md",
|
||||||
"skillFolderHash": "15f8c86d39ef834e643d092733ca899b59049067",
|
"skillFolderHash": "2ab11f2f51f3c29771edb5d4258d807a49462491",
|
||||||
"installedAt": "2026-06-27T19:37:25.607Z",
|
"installedAt": "2026-06-27T19:37:25.607Z",
|
||||||
"updatedAt": "2026-08-11T19:45:09.328Z"
|
"updatedAt": "2026-08-19T20:07:50.585Z"
|
||||||
},
|
},
|
||||||
"git-guardrails-claude-code": {
|
"git-guardrails-claude-code": {
|
||||||
"source": "mattpocock/skills",
|
"source": "mattpocock/skills",
|
||||||
"sourceType": "github",
|
"sourceType": "github",
|
||||||
"sourceUrl": "https://github.com/mattpocock/skills.git",
|
"sourceUrl": "https://github.com/mattpocock/skills.git",
|
||||||
"skillPath": "skills/misc/git-guardrails-claude-code/SKILL.md",
|
"skillPath": "skills/misc/git-guardrails-claude-code/SKILL.md",
|
||||||
"skillFolderHash": "e90e289cce7a31bdf1afdf591f0790d7ac6c3cbc",
|
"skillFolderHash": "ceed97af09633b300826d0ca0b1464c527ec9a35",
|
||||||
"installedAt": "2026-06-27T19:37:25.609Z",
|
"installedAt": "2026-06-27T19:37:25.609Z",
|
||||||
"updatedAt": "2026-08-11T19:45:10.038Z"
|
"updatedAt": "2026-08-19T20:07:51.378Z"
|
||||||
},
|
},
|
||||||
"implement": {
|
"implement": {
|
||||||
"source": "mattpocock/skills",
|
"source": "mattpocock/skills",
|
||||||
@@ -545,9 +545,9 @@
|
|||||||
"sourceType": "github",
|
"sourceType": "github",
|
||||||
"sourceUrl": "https://github.com/mattpocock/skills.git",
|
"sourceUrl": "https://github.com/mattpocock/skills.git",
|
||||||
"skillPath": "skills/in-progress/loop-me/SKILL.md",
|
"skillPath": "skills/in-progress/loop-me/SKILL.md",
|
||||||
"skillFolderHash": "6364da007c562d9f6ad3f54524dbc42465d9893a",
|
"skillFolderHash": "a0dfdc3562686d920900973b50289b36e2f7eafe",
|
||||||
"installedAt": "2026-06-27T19:37:25.609Z",
|
"installedAt": "2026-06-27T19:37:25.609Z",
|
||||||
"updatedAt": "2026-08-11T19:45:11.753Z"
|
"updatedAt": "2026-08-19T20:07:52.335Z"
|
||||||
},
|
},
|
||||||
"migrate-to-shoehorn": {
|
"migrate-to-shoehorn": {
|
||||||
"source": "mattpocock/skills",
|
"source": "mattpocock/skills",
|
||||||
@@ -563,9 +563,9 @@
|
|||||||
"sourceType": "github",
|
"sourceType": "github",
|
||||||
"sourceUrl": "https://github.com/mattpocock/skills.git",
|
"sourceUrl": "https://github.com/mattpocock/skills.git",
|
||||||
"skillPath": "skills/engineering/resolving-merge-conflicts/SKILL.md",
|
"skillPath": "skills/engineering/resolving-merge-conflicts/SKILL.md",
|
||||||
"skillFolderHash": "6aa1ed0b40fac0ebea5c0cf6f2addf82c99b6323",
|
"skillFolderHash": "77f0d7de3143abbf03e55a63522d30bff31ae908",
|
||||||
"installedAt": "2026-06-27T19:37:25.610Z",
|
"installedAt": "2026-06-27T19:37:25.610Z",
|
||||||
"updatedAt": "2026-08-11T19:45:13.102Z"
|
"updatedAt": "2026-08-19T20:07:53.041Z"
|
||||||
},
|
},
|
||||||
"scaffold-exercises": {
|
"scaffold-exercises": {
|
||||||
"source": "mattpocock/skills",
|
"source": "mattpocock/skills",
|
||||||
@@ -581,36 +581,36 @@
|
|||||||
"sourceType": "github",
|
"sourceType": "github",
|
||||||
"sourceUrl": "https://github.com/mattpocock/skills.git",
|
"sourceUrl": "https://github.com/mattpocock/skills.git",
|
||||||
"skillPath": "skills/misc/setup-pre-commit/SKILL.md",
|
"skillPath": "skills/misc/setup-pre-commit/SKILL.md",
|
||||||
"skillFolderHash": "dcc584ff84c4f040ea12742fcb46b7c3ad7070bd",
|
"skillFolderHash": "5b63f9f665bacc9be04cae51982e9ef1469d6699",
|
||||||
"installedAt": "2026-06-27T19:37:25.611Z",
|
"installedAt": "2026-06-27T19:37:25.611Z",
|
||||||
"updatedAt": "2026-08-11T19:45:14.627Z"
|
"updatedAt": "2026-08-19T20:07:54.015Z"
|
||||||
},
|
},
|
||||||
"writing-beats": {
|
"writing-beats": {
|
||||||
"source": "mattpocock/skills",
|
"source": "mattpocock/skills",
|
||||||
"sourceType": "github",
|
"sourceType": "github",
|
||||||
"sourceUrl": "https://github.com/mattpocock/skills.git",
|
"sourceUrl": "https://github.com/mattpocock/skills.git",
|
||||||
"skillPath": "skills/in-progress/writing-beats/SKILL.md",
|
"skillPath": "skills/in-progress/writing-beats/SKILL.md",
|
||||||
"skillFolderHash": "545d05c3fdbfdd094dd88900b0ef8c9a823eac90",
|
"skillFolderHash": "3a28fb076fdaaec0927080718abb98fc0f340011",
|
||||||
"installedAt": "2026-06-27T19:37:25.612Z",
|
"installedAt": "2026-06-27T19:37:25.612Z",
|
||||||
"updatedAt": "2026-08-11T19:45:15.352Z"
|
"updatedAt": "2026-08-19T20:07:55.088Z"
|
||||||
},
|
},
|
||||||
"writing-fragments": {
|
"writing-fragments": {
|
||||||
"source": "mattpocock/skills",
|
"source": "mattpocock/skills",
|
||||||
"sourceType": "github",
|
"sourceType": "github",
|
||||||
"sourceUrl": "https://github.com/mattpocock/skills.git",
|
"sourceUrl": "https://github.com/mattpocock/skills.git",
|
||||||
"skillPath": "skills/in-progress/writing-fragments/SKILL.md",
|
"skillPath": "skills/in-progress/writing-fragments/SKILL.md",
|
||||||
"skillFolderHash": "ce7d2741a30df8a488f6248c84cf954cff98393f",
|
"skillFolderHash": "98e500e0097ec80f52f6a024c5a2ff6d15235bdb",
|
||||||
"installedAt": "2026-06-27T19:37:25.612Z",
|
"installedAt": "2026-06-27T19:37:25.612Z",
|
||||||
"updatedAt": "2026-08-11T19:45:16.116Z"
|
"updatedAt": "2026-08-19T20:07:55.806Z"
|
||||||
},
|
},
|
||||||
"writing-shape": {
|
"writing-shape": {
|
||||||
"source": "mattpocock/skills",
|
"source": "mattpocock/skills",
|
||||||
"sourceType": "github",
|
"sourceType": "github",
|
||||||
"sourceUrl": "https://github.com/mattpocock/skills.git",
|
"sourceUrl": "https://github.com/mattpocock/skills.git",
|
||||||
"skillPath": "skills/in-progress/writing-shape/SKILL.md",
|
"skillPath": "skills/in-progress/writing-shape/SKILL.md",
|
||||||
"skillFolderHash": "31af0156520819c15d19358a8e0bd36f82e67ad3",
|
"skillFolderHash": "ac92229646fccf7315ae139c37b479b3790617f2",
|
||||||
"installedAt": "2026-06-27T19:37:25.613Z",
|
"installedAt": "2026-06-27T19:37:25.613Z",
|
||||||
"updatedAt": "2026-08-11T19:45:16.930Z"
|
"updatedAt": "2026-08-19T20:07:56.556Z"
|
||||||
},
|
},
|
||||||
"loopy": {
|
"loopy": {
|
||||||
"source": "Forward-Future/loop-library",
|
"source": "Forward-Future/loop-library",
|
||||||
@@ -636,9 +636,9 @@
|
|||||||
"sourceType": "github",
|
"sourceType": "github",
|
||||||
"sourceUrl": "https://github.com/vercel-labs/native.git",
|
"sourceUrl": "https://github.com/vercel-labs/native.git",
|
||||||
"skillPath": "skills/native-sdk/SKILL.md",
|
"skillPath": "skills/native-sdk/SKILL.md",
|
||||||
"skillFolderHash": "09d0442dd3e72e74148765b20eca2646035000c9",
|
"skillFolderHash": "621c3893fe0e8abcd32b94f9b36a601d0c29e06c",
|
||||||
"installedAt": "2026-07-09T15:09:31.311Z",
|
"installedAt": "2026-07-09T15:09:31.311Z",
|
||||||
"updatedAt": "2026-08-11T19:45:24.721Z"
|
"updatedAt": "2026-08-19T20:08:02.210Z"
|
||||||
},
|
},
|
||||||
"mintlify-api": {
|
"mintlify-api": {
|
||||||
"source": "mintlify.com",
|
"source": "mintlify.com",
|
||||||
@@ -679,9 +679,9 @@
|
|||||||
"sourceType": "github",
|
"sourceType": "github",
|
||||||
"sourceUrl": "https://github.com/haydenbleasel/blume.git",
|
"sourceUrl": "https://github.com/haydenbleasel/blume.git",
|
||||||
"skillPath": "skills/blume-migrate/SKILL.md",
|
"skillPath": "skills/blume-migrate/SKILL.md",
|
||||||
"skillFolderHash": "c237f0f0ab800a12ae869558122924b097f45721",
|
"skillFolderHash": "5de96dc489ba973cfce99ab4e6e7bd9bf8b6f3a3",
|
||||||
"installedAt": "2026-07-21T17:52:06.811Z",
|
"installedAt": "2026-07-21T17:52:06.811Z",
|
||||||
"updatedAt": "2026-08-14T01:06:59.321Z"
|
"updatedAt": "2026-08-19T20:08:03.736Z"
|
||||||
},
|
},
|
||||||
"rust-best-practices": {
|
"rust-best-practices": {
|
||||||
"source": "apollographql/skills",
|
"source": "apollographql/skills",
|
||||||
|
|||||||
@@ -70,7 +70,7 @@ The single biggest shift for most sources — especially Mintlify — is that **
|
|||||||
- **`navigation`:** `tabs`, `selectors`, `featured` (links pinned above the sidebar on every route), `sidebar` (`{ display, items }` — `display` is the global render mode above; `items` is an explicit tree), `repo`. **Avoid an explicit `navigation.sidebar` unless you have to** — lean on the filesystem-derived sidebar. It only works when the file tree roughly matches the intended sidebar layout, so reshape folders to match first; reach for `sidebar.items` only for a shape files genuinely can't express (see "Config-declared nesting" above).
|
- **`navigation`:** `tabs`, `selectors`, `featured` (links pinned above the sidebar on every route), `sidebar` (`{ display, items }` — `display` is the global render mode above; `items` is an explicit tree), `repo`. **Avoid an explicit `navigation.sidebar` unless you have to** — lean on the filesystem-derived sidebar. It only works when the file tree roughly matches the intended sidebar layout, so reshape folders to match first; reach for `sidebar.items` only for a shape files genuinely can't express (see "Config-declared nesting" above).
|
||||||
- **`search`** (Orama default, Pagefind opt-in), **`ai`** (llms.txt, Ask AI, the MCP server), **`openapi`**, **`redirects`**, **`seo`**, **`markdown`**, **`analytics`**, **`deployment`**, **`i18n`**, **`toc`**, **`lastModified`**, **`github`**.
|
- **`search`** (Orama default, Pagefind opt-in), **`ai`** (llms.txt, Ask AI, the MCP server), **`openapi`**, **`redirects`**, **`seo`**, **`markdown`**, **`analytics`**, **`deployment`**, **`i18n`**, **`toc`**, **`lastModified`**, **`github`**.
|
||||||
- **Don't set `deployment.site`.** Blume auto-fills it: the dev server's `localhost` URL in dev, and the deployment URL (`VERCEL_PROJECT_PRODUCTION_URL`/`VERCEL_URL`) on Vercel. Hardcoding it in `blume.config.ts` overrides that auto-detection and pins the wrong absolute URL (canonical links, sitemap, OG, llms.txt) everywhere but the one host you typed — so leave it unset even when a source config had a `url`/`site` field. (Sitemap still generates in production because the deploy URL is present there.)
|
- **Don't set `deployment.site`.** Blume auto-fills it: the dev server's `localhost` URL in dev, and the deployment URL (`VERCEL_PROJECT_PRODUCTION_URL`/`VERCEL_URL`) on Vercel. Hardcoding it in `blume.config.ts` overrides that auto-detection and pins the wrong absolute URL (canonical links, sitemap, OG, llms.txt) everywhere but the one host you typed — so leave it unset even when a source config had a `url`/`site` field. (Sitemap still generates in production because the deploy URL is present there.)
|
||||||
- **Favicon is a filename convention, not config.** Drop `icon`/`favicon.{svg,png,ico}` (and `apple-icon.png`) in the project root or `public/` — Blume auto-detects it. There is **no** `favicon` config field. A source favicon given as `{ light, dark }` **collapses to one** — pick a single file and report the loss.
|
- **Favicon is a filename convention, not config.** Drop `icon`/`favicon.{svg,png,ico}` (and `apple-icon.png`) in the project root or `public/` — Blume auto-detects it. There is **no** `favicon` config field. A source favicon given as `{ light, dark }` maps to a filename pair: copy the light file to a conventional name (e.g. `public/icon.png`) and the dark file to its `-dark` sibling — same directory and extension, `-dark` before the extension (`public/icon-dark.png`). If the two files have different formats, convert one so the extensions match; only an exact sibling of the resolved icon is picked up.
|
||||||
|
|
||||||
The schema is exported from `blume/schema`; the full field reference is in the `docs/configuration/` directory of the installed `blume` package (see "Full documentation" below for how to locate it).
|
The schema is exported from `blume/schema`; the full field reference is in the `docs/configuration/` directory of the installed `blume` package (see "Full documentation" below for how to locate it).
|
||||||
|
|
||||||
|
|||||||
@@ -19,7 +19,7 @@ Resolve `$ref` includes first (Mintlify splits config across files). Map only wh
|
|||||||
| `name` / `title` | `title` | |
|
| `name` / `title` | `title` | |
|
||||||
| `description` | `description` | |
|
| `description` | `description` | |
|
||||||
| `logo` (string or `{ light, dark, href }`) | `logo` (string, or `{ image: { light, dark, alt }, text, href }`) | Mintlify's `light`/`dark` nest under Blume's `image`; ensure files land in `public/`. **If the SVG is local and monochrome** (a solid black or white mark), rewrite its `fill`/`stroke` to `currentColor` and collapse `{ light, dark }` to the string shorthand `logo: "/logo.svg"` — one file that inherits the theme text color and flips with light/dark automatically. If the logo is a **wordmark** (brand name baked in), set `text: ""` so it doesn't render twice beside `title` |
|
| `logo` (string or `{ light, dark, href }`) | `logo` (string, or `{ image: { light, dark, alt }, text, href }`) | Mintlify's `light`/`dark` nest under Blume's `image`; ensure files land in `public/`. **If the SVG is local and monochrome** (a solid black or white mark), rewrite its `fill`/`stroke` to `currentColor` and collapse `{ light, dark }` to the string shorthand `logo: "/logo.svg"` — one file that inherits the theme text color and flips with light/dark automatically. If the logo is a **wordmark** (brand name baked in), set `text: ""` so it doesn't render twice beside `title` |
|
||||||
| `favicon` (string **or `{ light, dark }`**) | **drop the field** — copy **one** file into `public/` under the conventional name (`favicon.svg`/`icon.png`) | Blume auto-detects by filename; there is **no** favicon config field, and **no** light/dark favicon — a `{ light, dark }` source collapses to one; report the loss |
|
| `favicon` (string **or `{ light, dark }`**) | **drop the field** — copy the file(s) into `public/` under conventional names (`favicon.svg`/`icon.png`) | Blume auto-detects by filename; there is **no** favicon config field. A `{ light, dark }` source maps to a filename pair: light file → `public/icon.png`, dark file → its `-dark` sibling `public/icon-dark.png` (same directory and extension — convert if the formats differ) |
|
||||||
| `colors.primary` + `colors.light` | `theme.accent` (`{ light, dark }`) | accent is now **per-mode**: `accent: { light: <colors.primary>, dark: <colors.light> }`. If Mintlify sets only `primary`, collapse to the string shorthand `accent: "<colors.primary>"` (applies to both modes) |
|
| `colors.primary` + `colors.light` | `theme.accent` (`{ light, dark }`) | accent is now **per-mode**: `accent: { light: <colors.primary>, dark: <colors.light> }`. If Mintlify sets only `primary`, collapse to the string shorthand `accent: "<colors.primary>"` (applies to both modes) |
|
||||||
| `colors.dark` | `theme.action` | |
|
| `colors.dark` | `theme.action` | |
|
||||||
| `appearance.default` | `theme.mode` (`light`/`dark`/`system`) | |
|
| `appearance.default` | `theme.mode` (`light`/`dark`/`system`) | |
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
# Deepening
|
# Deepening
|
||||||
|
|
||||||
How to deepen a cluster of shallow modules safely, given its dependencies. Assumes the vocabulary in [SKILL.md](SKILL.md) — **module**, **interface**, **seam**, **adapter**.
|
How to deepen a cluster of shallow modules safely, given its dependencies. Assumes the vocabulary in [SKILL.md](SKILL.md): **module**, **interface**, **seam**, **adapter**.
|
||||||
|
|
||||||
## Dependency categories
|
## Dependency categories
|
||||||
|
|
||||||
@@ -8,7 +8,7 @@ When assessing a candidate for deepening, classify its dependencies. The categor
|
|||||||
|
|
||||||
### 1. In-process
|
### 1. In-process
|
||||||
|
|
||||||
Pure computation, in-memory state, no I/O. Always deepenable — merge the modules and test through the new interface directly. No adapter needed.
|
Pure computation, in-memory state, no I/O. Always deepenable: merge the modules and test through the new interface directly. No adapter needed.
|
||||||
|
|
||||||
### 2. Local-substitutable
|
### 2. Local-substitutable
|
||||||
|
|
||||||
@@ -31,7 +31,7 @@ Third-party services (Stripe, Twilio, etc.) you don't control. The deepened modu
|
|||||||
|
|
||||||
## Testing strategy: replace, don't layer
|
## Testing strategy: replace, don't layer
|
||||||
|
|
||||||
- Old unit tests on shallow modules become waste once tests at the deepened module's interface exist — delete them.
|
- Old unit tests on shallow modules become waste once tests at the deepened module's interface exist; delete them.
|
||||||
- Write new tests at the deepened module's interface. The **interface is the test surface**.
|
- Write new tests at the deepened module's interface. The **interface is the test surface**.
|
||||||
- Tests assert on observable outcomes through the interface, not internal state.
|
- Tests assert on observable outcomes through the interface, not internal state.
|
||||||
- Tests should survive internal refactors — they describe behaviour, not implementation. If a test has to change when the implementation changes, it's testing past the interface.
|
- Tests should survive internal refactors, since they describe behaviour, not implementation. If a test has to change when the implementation changes, it's testing past the interface.
|
||||||
@@ -1,8 +1,8 @@
|
|||||||
# Design It Twice
|
# Design It Twice
|
||||||
|
|
||||||
When the user wants to explore alternative interfaces for a chosen deepening candidate, use this parallel sub-agent pattern. Based on "Design It Twice" (Ousterhout) — your first idea is unlikely to be the best.
|
When the user wants to explore alternative interfaces for a chosen deepening candidate, use this parallel sub-agent pattern. Based on "Design It Twice" (Ousterhout): your first idea is unlikely to be the best.
|
||||||
|
|
||||||
Uses the vocabulary in [SKILL.md](SKILL.md) — **module**, **interface**, **seam**, **adapter**, **leverage**.
|
Uses the vocabulary in [SKILL.md](SKILL.md): **module**, **interface**, **seam**, **adapter**, **leverage**.
|
||||||
|
|
||||||
## Process
|
## Process
|
||||||
|
|
||||||
@@ -12,7 +12,7 @@ Before spawning sub-agents, write a user-facing explanation of the problem space
|
|||||||
|
|
||||||
- The constraints any new interface would need to satisfy
|
- The constraints any new interface would need to satisfy
|
||||||
- The dependencies it would rely on, and which category they fall into (see [DEEPENING.md](DEEPENING.md))
|
- The dependencies it would rely on, and which category they fall into (see [DEEPENING.md](DEEPENING.md))
|
||||||
- A rough illustrative code sketch to ground the constraints — not a proposal, just a way to make the constraints concrete
|
- A rough illustrative code sketch to ground the constraints, not a proposal, just a way to make the constraints concrete
|
||||||
|
|
||||||
Show this to the user, then immediately proceed to Step 2. The user reads and thinks while the sub-agents work in parallel.
|
Show this to the user, then immediately proceed to Step 2. The user reads and thinks while the sub-agents work in parallel.
|
||||||
|
|
||||||
@@ -22,23 +22,23 @@ Spawn 3+ sub-agents in parallel. Each must produce a **radically different** int
|
|||||||
|
|
||||||
Prompt each sub-agent with a separate technical brief (file paths, coupling details, dependency category from [DEEPENING.md](DEEPENING.md), what sits behind the seam). The brief is independent of the user-facing problem-space explanation in Step 1. Give each agent a different design constraint:
|
Prompt each sub-agent with a separate technical brief (file paths, coupling details, dependency category from [DEEPENING.md](DEEPENING.md), what sits behind the seam). The brief is independent of the user-facing problem-space explanation in Step 1. Give each agent a different design constraint:
|
||||||
|
|
||||||
- Agent 1: "Minimize the interface — aim for 1–3 entry points max. Maximise leverage per entry point."
|
- Agent 1: "Minimize the interface: aim for 1–3 entry points max. Maximise leverage per entry point."
|
||||||
- Agent 2: "Maximise flexibility — support many use cases and extension."
|
- Agent 2: "Maximise flexibility: support many use cases and extension."
|
||||||
- Agent 3: "Optimise for the most common caller — make the default case trivial."
|
- Agent 3: "Optimise for the most common caller: make the default case trivial."
|
||||||
- Agent 4 (if applicable): "Design around ports & adapters for cross-seam dependencies."
|
- Agent 4 (if applicable): "Design around ports & adapters for cross-seam dependencies."
|
||||||
|
|
||||||
Include both [SKILL.md](SKILL.md) vocabulary and CONTEXT.md vocabulary in the brief so each sub-agent names things consistently with the architecture language and the project's domain language.
|
Include both [SKILL.md](SKILL.md) vocabulary and CONTEXT.md vocabulary in the brief so each sub-agent names things consistently with the architecture language and the project's domain language.
|
||||||
|
|
||||||
Each sub-agent outputs:
|
Each sub-agent outputs:
|
||||||
|
|
||||||
1. Interface (types, methods, params — plus invariants, ordering, error modes)
|
1. Interface (types, methods, params, plus invariants, ordering, error modes)
|
||||||
2. Usage example showing how callers use it
|
2. Usage example showing how callers use it
|
||||||
3. What the implementation hides behind the seam
|
3. What the implementation hides behind the seam
|
||||||
4. Dependency strategy and adapters (see [DEEPENING.md](DEEPENING.md))
|
4. Dependency strategy and adapters (see [DEEPENING.md](DEEPENING.md))
|
||||||
5. Trade-offs — where leverage is high, where it's thin
|
5. Trade-offs: where leverage is high, where it's thin
|
||||||
|
|
||||||
### 3. Present and compare
|
### 3. Present and compare
|
||||||
|
|
||||||
Present designs sequentially so the user can absorb each one, then compare them in prose. Contrast by **depth** (leverage at the interface), **locality** (where change concentrates), and **seam placement**.
|
Present designs sequentially so the user can absorb each one, then compare them in prose. Contrast by **depth** (leverage at the interface), **locality** (where change concentrates), and **seam placement**.
|
||||||
|
|
||||||
After comparing, give your own recommendation: which design you think is strongest and why. If elements from different designs would combine well, propose a hybrid. Be opinionated — the user wants a strong read, not a menu.
|
After comparing, give your own recommendation: which design you think is strongest and why. If elements from different designs would combine well, propose a hybrid. Be opinionated: the user wants a strong read, not a menu.
|
||||||
@@ -9,23 +9,23 @@ Design **deep modules**: a lot of behaviour behind a small interface, placed at
|
|||||||
|
|
||||||
## Glossary
|
## Glossary
|
||||||
|
|
||||||
Use these terms exactly — don't substitute "component," "service," "API," or "boundary." Consistent language is the whole point.
|
Use these terms exactly: don't substitute "component," "service," "API," or "boundary." Consistent language is the whole point.
|
||||||
|
|
||||||
**Module** — anything with an interface and an implementation. Deliberately scale-agnostic: a function, class, package, or tier-spanning slice. _Avoid_: unit, component, service.
|
**Module**: anything with an interface and an implementation. Deliberately scale-agnostic: a function, class, package, or tier-spanning slice. _Avoid_: unit, component, service.
|
||||||
|
|
||||||
**Interface** — everything a caller must know to use the module correctly: the type signature, but also invariants, ordering constraints, error modes, required configuration, and performance characteristics. _Avoid_: API, signature (too narrow — they refer only to the type-level surface).
|
**Interface**: everything a caller must know to use the module correctly: the type signature, but also invariants, ordering constraints, error modes, required configuration, and performance characteristics. _Avoid_: API, signature (too narrow, they refer only to the type-level surface).
|
||||||
|
|
||||||
**Implementation** — what's inside a module, its body of code. Distinct from **Adapter**: a thing can be a small adapter with a large implementation (a Postgres repo) or a large adapter with a small implementation (an in-memory fake). Reach for "adapter" when the seam is the topic; "implementation" otherwise.
|
**Implementation**: what's inside a module, its body of code. Distinct from **Adapter**: a thing can be a small adapter with a large implementation (a Postgres repo) or a large adapter with a small implementation (an in-memory fake). Reach for "adapter" when the seam is the topic; "implementation" otherwise.
|
||||||
|
|
||||||
**Depth** — leverage at the interface: the amount of behaviour a caller (or test) can exercise per unit of interface they have to learn. A module is **deep** when a large amount of behaviour sits behind a small interface, **shallow** when the interface is nearly as complex as the implementation.
|
**Depth**: leverage at the interface. The amount of behaviour a caller (or test) can exercise per unit of interface they have to learn. A module is **deep** when a large amount of behaviour sits behind a small interface, **shallow** when the interface is nearly as complex as the implementation.
|
||||||
|
|
||||||
**Seam** _(Michael Feathers)_ — a place where you can alter behaviour without editing in that place; the *location* at which a module's interface lives. Where to put the seam is its own design decision, distinct from what goes behind it. _Avoid_: boundary (overloaded with DDD's bounded context).
|
**Seam** _(Michael Feathers)_: a place where you can alter behaviour without editing in that place; the *location* at which a module's interface lives. Where to put the seam is its own design decision, distinct from what goes behind it. _Avoid_: boundary (overloaded with DDD's bounded context).
|
||||||
|
|
||||||
**Adapter** — a concrete thing that satisfies an interface at a seam. Describes *role* (what slot it fills), not substance (what's inside).
|
**Adapter**: a concrete thing that satisfies an interface at a seam. Describes *role* (what slot it fills), not substance (what's inside).
|
||||||
|
|
||||||
**Leverage** — what callers get from depth: more capability per unit of interface they learn. One implementation pays back across N call sites and M tests.
|
**Leverage**: what callers get from depth. More capability per unit of interface they learn. One implementation pays back across N call sites and M tests.
|
||||||
|
|
||||||
**Locality** — what maintainers get from depth: change, bugs, knowledge, and verification concentrate in one place rather than spreading across callers. Fix once, fixed everywhere.
|
**Locality**: what maintainers get from depth. Change, bugs, knowledge, and verification concentrate in one place rather than spreading across callers. Fix once, fixed everywhere.
|
||||||
|
|
||||||
## Deep vs shallow
|
## Deep vs shallow
|
||||||
|
|
||||||
@@ -59,7 +59,7 @@ When designing an interface, ask:
|
|||||||
|
|
||||||
## Principles
|
## Principles
|
||||||
|
|
||||||
- **Depth is a property of the interface, not the implementation.** A deep module can be internally composed of small, mockable, swappable parts — they just aren't part of the interface. A module can have **internal seams** (private to its implementation, used by its own tests) as well as the **external seam** at its interface.
|
- **Depth is a property of the interface, not the implementation.** A deep module can be internally composed of small, mockable, swappable parts; they just aren't part of the interface. A module can have **internal seams** (private to its implementation, used by its own tests) as well as the **external seam** at its interface.
|
||||||
- **The deletion test.** Imagine deleting the module. If complexity vanishes, it was a pass-through. If complexity reappears across N callers, it was earning its keep.
|
- **The deletion test.** Imagine deleting the module. If complexity vanishes, it was a pass-through. If complexity reappears across N callers, it was earning its keep.
|
||||||
- **The interface is the test surface.** Callers and tests cross the same seam. If you want to test *past* the interface, the module is probably the wrong shape.
|
- **The interface is the test surface.** Callers and tests cross the same seam. If you want to test *past* the interface, the module is probably the wrong shape.
|
||||||
- **One adapter means a hypothetical seam. Two adapters means a real one.** Don't introduce a seam unless something actually varies across it.
|
- **One adapter means a hypothetical seam. Two adapters means a real one.** Don't introduce a seam unless something actually varies across it.
|
||||||
@@ -105,10 +105,10 @@ Good interfaces make testing natural:
|
|||||||
## Rejected framings
|
## Rejected framings
|
||||||
|
|
||||||
- **Depth as ratio of implementation-lines to interface-lines** (Ousterhout): rewards padding the implementation. We use depth-as-leverage instead.
|
- **Depth as ratio of implementation-lines to interface-lines** (Ousterhout): rewards padding the implementation. We use depth-as-leverage instead.
|
||||||
- **"Interface" as the TypeScript `interface` keyword or a class's public methods**: too narrow — interface here includes every fact a caller must know.
|
- **"Interface" as the TypeScript `interface` keyword or a class's public methods**: too narrow: interface here includes every fact a caller must know.
|
||||||
- **"Boundary"**: overloaded with DDD's bounded context. Say **seam** or **interface**.
|
- **"Boundary"**: overloaded with DDD's bounded context. Say **seam** or **interface**.
|
||||||
|
|
||||||
## Going deeper
|
## Going deeper
|
||||||
|
|
||||||
- **Deepening a cluster given its dependencies** — see [DEEPENING.md](DEEPENING.md): dependency categories, seam discipline, and replace-don't-layer testing.
|
- **Deepening a cluster given its dependencies**, see [DEEPENING.md](DEEPENING.md): dependency categories, seam discipline, and replace-don't-layer testing.
|
||||||
- **Exploring alternative interfaces** — see [DESIGN-IT-TWICE.md](DESIGN-IT-TWICE.md): spin up parallel sub-agents to design the interface several radically different ways, then compare on depth, locality, and seam placement.
|
- **Exploring alternative interfaces**, see [DESIGN-IT-TWICE.md](DESIGN-IT-TWICE.md): spin up parallel sub-agents to design the interface several radically different ways, then compare on depth, locality, and seam placement.
|
||||||
@@ -11,22 +11,22 @@ When exploring the codebase, read `CONTEXT.md` (if it exists) to get a clear men
|
|||||||
|
|
||||||
## Redact
|
## Redact
|
||||||
|
|
||||||
This skill has you show commands, outputs and captured artifacts. **Redact every secret first** — write `<REDACTED>` in its place. Build loops against env vars, so the credential stays in the environment rather than in what you show. Captured artifacts carry auth headers: quote only the lines that carry the signal.
|
This skill has you show commands, outputs and captured artifacts. **Redact every secret first**: write `<REDACTED>` in its place. Build loops against env vars, so the credential stays in the environment rather than in what you show. Captured artifacts carry auth headers: quote only the lines that carry the signal.
|
||||||
|
|
||||||
If the redacted output is not enough to diagnose the bug, say so and ask the user.
|
If the redacted output is not enough to diagnose the bug, say so and ask the user.
|
||||||
|
|
||||||
## Phase 1 — Build a feedback loop
|
## Phase 1: Build a feedback loop
|
||||||
|
|
||||||
**This is the skill.** Everything else is mechanical. If you have a **tight** pass/fail signal for the bug — one that goes red on _this_ bug — you will find the cause; bisection, hypothesis-testing, and instrumentation all just consume it. If you don't have one, no amount of staring at code will save you.
|
**This is the skill.** Everything else is mechanical. If you have a **tight** pass/fail signal for the bug (one that goes red on _this_ bug), you will find the cause; bisection, hypothesis-testing, and instrumentation all just consume it. If you don't have one, no amount of staring at code will save you.
|
||||||
|
|
||||||
Spend disproportionate effort here. **Be aggressive. Be creative. Refuse to give up.**
|
Spend disproportionate effort here. **Be aggressive. Be creative. Refuse to give up.**
|
||||||
|
|
||||||
### Ways to construct one — try them in roughly this order
|
### Ways to construct one, in roughly this order
|
||||||
|
|
||||||
1. **Failing test** at whatever seam reaches the bug — unit, integration, e2e.
|
1. **Failing test** at whatever seam reaches the bug: unit, integration, e2e.
|
||||||
2. **Curl / HTTP script** against a running dev server.
|
2. **Curl / HTTP script** against a running dev server.
|
||||||
3. **CLI invocation** with a fixture input, diffing stdout against a known-good snapshot.
|
3. **CLI invocation** with a fixture input, diffing stdout against a known-good snapshot.
|
||||||
4. **Headless browser script** (Playwright / Puppeteer) — drives the UI, asserts on DOM/console/network.
|
4. **Headless browser script** (Playwright / Puppeteer) that drives the UI and asserts on DOM/console/network.
|
||||||
5. **Replay a captured trace.** Save a real network request / payload / event log to disk; replay it through the code path in isolation.
|
5. **Replay a captured trace.** Save a real network request / payload / event log to disk; replay it through the code path in isolation.
|
||||||
6. **Throwaway harness.** Spin up a minimal subset of the system (one service, mocked deps) that exercises the bug code path with a single function call.
|
6. **Throwaway harness.** Spin up a minimal subset of the system (one service, mocked deps) that exercises the bug code path with a single function call.
|
||||||
7. **Property / fuzz loop.** If the bug is "sometimes wrong output", run 1000 random inputs and look for the failure mode.
|
7. **Property / fuzz loop.** If the bug is "sometimes wrong output", run 1000 random inputs and look for the failure mode.
|
||||||
@@ -44,48 +44,48 @@ Treat the loop as a product. Once you have _a_ loop, **tighten** it:
|
|||||||
- Can I make the signal sharper? (Assert on the specific symptom, not "didn't crash".)
|
- Can I make the signal sharper? (Assert on the specific symptom, not "didn't crash".)
|
||||||
- Can I make it more deterministic? (Pin time, seed RNG, isolate filesystem, freeze network.)
|
- Can I make it more deterministic? (Pin time, seed RNG, isolate filesystem, freeze network.)
|
||||||
|
|
||||||
A 30-second flaky loop is barely better than no loop; a 2-second deterministic one is tight — a debugging superpower.
|
A 30-second flaky loop is barely better than no loop; a 2-second deterministic one is tight, a debugging superpower.
|
||||||
|
|
||||||
### Non-deterministic bugs
|
### Non-deterministic bugs
|
||||||
|
|
||||||
The goal is not a clean repro but a **higher reproduction rate**. Loop the trigger 100×, parallelise, add stress, narrow timing windows, inject sleeps. A 50%-flake bug is debuggable; 1% is not — keep raising the rate until it's debuggable.
|
The goal is not a clean repro but a **higher reproduction rate**. Loop the trigger 100×, parallelise, add stress, narrow timing windows, inject sleeps. A 50%-flake bug is debuggable; 1% is not, so keep raising the rate until it's debuggable.
|
||||||
|
|
||||||
### When you genuinely cannot build a loop
|
### When you genuinely cannot build a loop
|
||||||
|
|
||||||
Stop and say so explicitly. List what you tried. Ask the user for: (a) access to whatever environment reproduces it, (b) a redacted captured artifact (HAR file, log dump, core dump, screen recording with timestamps), or (c) permission to add temporary production instrumentation. Do **not** proceed to hypothesise without a loop.
|
Stop and say so explicitly. List what you tried. Ask the user for: (a) access to whatever environment reproduces it, (b) a redacted captured artifact (HAR file, log dump, core dump, screen recording with timestamps), or (c) permission to add temporary production instrumentation. Do **not** proceed to hypothesise without a loop.
|
||||||
|
|
||||||
### Completion criterion — a tight loop that goes red
|
### Completion criterion: a tight loop that goes red
|
||||||
|
|
||||||
Phase 1 is done when the loop is **tight** and **red-capable**: you can name **one command** — a script path, a test invocation, a curl — that you have **already run at least once** (show the invocation and its output, redacted), and that is:
|
Phase 1 is done when the loop is **tight** and **red-capable**: you can name **one command** (a script path, a test invocation, a curl) that you have **already run at least once** (show the invocation and its output, redacted), and that is:
|
||||||
|
|
||||||
- [ ] **Red-capable** — it drives the actual bug code path and asserts the **user's exact symptom**, so it can go red on this bug and green once fixed. Not "runs without erroring" — it must be able to _catch this specific bug_.
|
- [ ] **Red-capable**: it drives the actual bug code path and asserts the **user's exact symptom**, so it can go red on this bug and green once fixed. Not "runs without erroring"; it must be able to _catch this specific bug_.
|
||||||
- [ ] **Deterministic** — same verdict every run (flaky bugs: a pinned, high reproduction rate, per above).
|
- [ ] **Deterministic**: same verdict every run (flaky bugs: a pinned, high reproduction rate, per above).
|
||||||
- [ ] **Fast** — seconds, not minutes.
|
- [ ] **Fast**: seconds, not minutes.
|
||||||
- [ ] **Agent-runnable** — you can run it unattended; a human in the loop only via `scripts/hitl-loop.template.sh`.
|
- [ ] **Agent-runnable**: you can run it unattended; a human in the loop only via `scripts/hitl-loop.template.sh`.
|
||||||
|
|
||||||
If you catch yourself reading code to build a theory before this command exists, **stop — jumping straight to a hypothesis is the exact failure this skill prevents.** No red-capable command, no Phase 2.
|
If you catch yourself reading code to build a theory before this command exists, **stop: jumping straight to a hypothesis is the exact failure this skill prevents.** No red-capable command, no Phase 2.
|
||||||
|
|
||||||
## Phase 2 — Reproduce + minimise
|
## Phase 2: Reproduce + minimise
|
||||||
|
|
||||||
Run the loop. Watch it go red — the bug appears.
|
Run the loop. Watch it go red as the bug appears.
|
||||||
|
|
||||||
Confirm:
|
Confirm:
|
||||||
|
|
||||||
- [ ] The loop produces the failure mode the **user** described — not a different failure that happens to be nearby. Wrong bug = wrong fix.
|
- [ ] The loop produces the failure mode the **user** described, not a different failure that happens to be nearby. Wrong bug = wrong fix.
|
||||||
- [ ] The failure is reproducible across multiple runs (or, for non-deterministic bugs, reproducible at a high enough rate to debug against).
|
- [ ] The failure is reproducible across multiple runs (or, for non-deterministic bugs, reproducible at a high enough rate to debug against).
|
||||||
- [ ] You have captured the exact symptom (error message, wrong output, slow timing) so later phases can verify the fix actually addresses it.
|
- [ ] You have captured the exact symptom (error message, wrong output, slow timing) so later phases can verify the fix actually addresses it.
|
||||||
|
|
||||||
### Minimise
|
### Minimise
|
||||||
|
|
||||||
Once it's red, shrink the repro to the **smallest scenario that still goes red**. Cut inputs, callers, config, data, and steps **one at a time**, re-running the loop after each cut — keep only what's load-bearing for the failure.
|
Once it's red, shrink the repro to the **smallest scenario that still goes red**. Cut inputs, callers, config, data, and steps **one at a time**, re-running the loop after each cut, and keep only what's load-bearing for the failure.
|
||||||
|
|
||||||
Why bother: a minimal repro shrinks the hypothesis space in Phase 3 (fewer moving parts left to suspect) and becomes the clean regression test in Phase 5.
|
Why bother: a minimal repro shrinks the hypothesis space in Phase 3 (fewer moving parts left to suspect) and becomes the clean regression test in Phase 5.
|
||||||
|
|
||||||
Done when **every remaining element is load-bearing** — removing any one of them makes the loop go green.
|
Done when **every remaining element is load-bearing**: removing any one of them makes the loop go green.
|
||||||
|
|
||||||
Do not proceed until you have reproduced **and** minimised.
|
Do not proceed until you have reproduced **and** minimised.
|
||||||
|
|
||||||
## Phase 3 — Hypothesise
|
## Phase 3: Hypothesise
|
||||||
|
|
||||||
Generate **3–5 ranked hypotheses** before testing any of them. Single-hypothesis generation anchors on the first plausible idea.
|
Generate **3–5 ranked hypotheses** before testing any of them. Single-hypothesis generation anchors on the first plausible idea.
|
||||||
|
|
||||||
@@ -93,11 +93,11 @@ Each hypothesis must be **falsifiable**: state the prediction it makes.
|
|||||||
|
|
||||||
> Format: "If <X> is the cause, then <changing Y> will make the bug disappear / <changing Z> will make it worse."
|
> Format: "If <X> is the cause, then <changing Y> will make the bug disappear / <changing Z> will make it worse."
|
||||||
|
|
||||||
If you cannot state the prediction, the hypothesis is a vibe — discard or sharpen it.
|
If you cannot state the prediction, the hypothesis is a vibe: discard or sharpen it.
|
||||||
|
|
||||||
**Show the ranked list to the user before testing.** They often have domain knowledge that re-ranks instantly ("we just deployed a change to #3"), or know hypotheses they've already ruled out. Cheap checkpoint, big time saver. Don't block on it — proceed with your ranking if the user is AFK.
|
**Show the ranked list to the user before testing.** They often have domain knowledge that re-ranks instantly ("we just deployed a change to #3"), or know hypotheses they've already ruled out. Cheap checkpoint, big time saver. Don't block on it; proceed with your ranking if the user is AFK.
|
||||||
|
|
||||||
## Phase 4 — Instrument
|
## Phase 4: Instrument
|
||||||
|
|
||||||
Each probe must map to a specific prediction from Phase 3. **Change one variable at a time.**
|
Each probe must map to a specific prediction from Phase 3. **Change one variable at a time.**
|
||||||
|
|
||||||
@@ -111,9 +111,9 @@ Tool preference:
|
|||||||
|
|
||||||
**Perf branch.** For performance regressions, logs are usually wrong. Instead: establish a baseline measurement (timing harness, `performance.now()`, profiler, query plan), then bisect. Measure first, fix second.
|
**Perf branch.** For performance regressions, logs are usually wrong. Instead: establish a baseline measurement (timing harness, `performance.now()`, profiler, query plan), then bisect. Measure first, fix second.
|
||||||
|
|
||||||
## Phase 5 — Fix + regression test
|
## Phase 5: Fix + regression test
|
||||||
|
|
||||||
Write the regression test **before the fix** — but only if there is a **correct seam** for it.
|
Write the regression test **before the fix**, but only if there is a **correct seam** for it.
|
||||||
|
|
||||||
A correct seam is one where the test exercises the **real bug pattern** as it occurs at the call site. If the only available seam is too shallow (single-caller test when the bug needs multiple callers, unit test that can't replicate the chain that triggered the bug), a regression test there gives false confidence.
|
A correct seam is one where the test exercises the **real bug pattern** as it occurs at the call site. If the only available seam is too shallow (single-caller test when the bug needs multiple callers, unit test that can't replicate the chain that triggered the bug), a regression test there gives false confidence.
|
||||||
|
|
||||||
@@ -127,7 +127,7 @@ If a correct seam exists:
|
|||||||
4. Watch it pass.
|
4. Watch it pass.
|
||||||
5. Re-run the Phase 1 feedback loop against the original (un-minimised) scenario.
|
5. Re-run the Phase 1 feedback loop against the original (un-minimised) scenario.
|
||||||
|
|
||||||
## Phase 6 — Cleanup
|
## Phase 6: Cleanup
|
||||||
|
|
||||||
Required before declaring done:
|
Required before declaring done:
|
||||||
|
|
||||||
@@ -135,4 +135,4 @@ Required before declaring done:
|
|||||||
- [ ] Regression test passes (or absence of seam is documented)
|
- [ ] Regression test passes (or absence of seam is documented)
|
||||||
- [ ] All `[DEBUG-...]` instrumentation removed (`grep` the prefix)
|
- [ ] All `[DEBUG-...]` instrumentation removed (`grep` the prefix)
|
||||||
- [ ] Throwaway prototypes deleted (or moved to a clearly-marked debug location)
|
- [ ] Throwaway prototypes deleted (or moved to a clearly-marked debug location)
|
||||||
- [ ] The hypothesis that turned out correct is stated in the commit / PR message — so the next debugger learns
|
- [ ] The hypothesis that turned out correct is stated in the commit / PR message, so the next debugger learns
|
||||||
@@ -12,8 +12,8 @@
|
|||||||
#
|
#
|
||||||
# At the end, captured values are printed as KEY=VALUE for the agent to parse.
|
# At the end, captured values are printed as KEY=VALUE for the agent to parse.
|
||||||
#
|
#
|
||||||
# `capture` prints its value back to the terminal, where the agent reads it — so
|
# `capture` prints its value back to the terminal, where the agent reads it,
|
||||||
# capture observations, and leave signing in to the user as a `step`.
|
# so capture observations, and leave signing in to the user as a `step`.
|
||||||
|
|
||||||
set -euo pipefail
|
set -euo pipefail
|
||||||
|
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
ADRs live in `docs/adr/` and use sequential numbering: `0001-slug.md`, `0002-slug.md`, etc.
|
ADRs live in `docs/adr/` and use sequential numbering: `0001-slug.md`, `0002-slug.md`, etc.
|
||||||
|
|
||||||
Create the `docs/adr/` directory lazily — only when the first ADR is needed.
|
Create the `docs/adr/` directory lazily: only when the first ADR is needed.
|
||||||
|
|
||||||
## Template
|
## Template
|
||||||
|
|
||||||
@@ -12,15 +12,15 @@ Create the `docs/adr/` directory lazily — only when the first ADR is needed.
|
|||||||
{1-3 sentences: what's the context, what did we decide, and why.}
|
{1-3 sentences: what's the context, what did we decide, and why.}
|
||||||
```
|
```
|
||||||
|
|
||||||
That's it. An ADR can be a single paragraph. The value is in recording *that* a decision was made and *why* — not in filling out sections.
|
That's it. An ADR can be a single paragraph. The value is in recording *that* a decision was made and *why*, not in filling out sections.
|
||||||
|
|
||||||
## Optional sections
|
## Optional sections
|
||||||
|
|
||||||
Only include these when they add genuine value. Most ADRs won't need them.
|
Only include these when they add genuine value. Most ADRs won't need them.
|
||||||
|
|
||||||
- **Status** frontmatter (`proposed | accepted | deprecated | superseded by ADR-NNNN`) — useful when decisions are revisited
|
- **Status** frontmatter (`proposed | accepted | deprecated | superseded by ADR-NNNN`): useful when decisions are revisited
|
||||||
- **Considered Options** — only when the rejected alternatives are worth remembering
|
- **Considered Options**: only when the rejected alternatives are worth remembering
|
||||||
- **Consequences** — only when non-obvious downstream effects need to be called out
|
- **Consequences**: only when non-obvious downstream effects need to be called out
|
||||||
|
|
||||||
## Numbering
|
## Numbering
|
||||||
|
|
||||||
@@ -30,18 +30,18 @@ Scan `docs/adr/` for the highest existing number and increment by one.
|
|||||||
|
|
||||||
All three of these must be true:
|
All three of these must be true:
|
||||||
|
|
||||||
1. **Hard to reverse** — the cost of changing your mind later is meaningful
|
1. **Hard to reverse**: the cost of changing your mind later is meaningful
|
||||||
2. **Surprising without context** — a future reader will look at the code and wonder "why on earth did they do it this way?"
|
2. **Surprising without context**: a future reader will look at the code and wonder "why on earth did they do it this way?"
|
||||||
3. **The result of a real trade-off** — there were genuine alternatives and you picked one for specific reasons
|
3. **The result of a real trade-off**: there were genuine alternatives and you picked one for specific reasons
|
||||||
|
|
||||||
If a decision is easy to reverse, skip it — you'll just reverse it. If it's not surprising, nobody will wonder why. If there was no real alternative, there's nothing to record beyond "we did the obvious thing."
|
If a decision is easy to reverse, skip it: you'll just reverse it. If it's not surprising, nobody will wonder why. If there was no real alternative, there's nothing to record beyond "we did the obvious thing."
|
||||||
|
|
||||||
### What qualifies
|
### What qualifies
|
||||||
|
|
||||||
- **Architectural shape.** "We're using a monorepo." "The write model is event-sourced, the read model is projected into Postgres."
|
- **Architectural shape.** "We're using a monorepo." "The write model is event-sourced, the read model is projected into Postgres."
|
||||||
- **Integration patterns between contexts.** "Ordering and Billing communicate via domain events, not synchronous HTTP."
|
- **Integration patterns between contexts.** "Ordering and Billing communicate via domain events, not synchronous HTTP."
|
||||||
- **Technology choices that carry lock-in.** Database, message bus, auth provider, deployment target. Not every library — just the ones that would take a quarter to swap out.
|
- **Technology choices that carry lock-in.** Database, message bus, auth provider, deployment target. Not every library: just the ones that would take a quarter to swap out.
|
||||||
- **Boundary and scope decisions.** "Customer data is owned by the Customer context; other contexts reference it by ID only." The explicit no-s are as valuable as the yes-s.
|
- **Boundary and scope decisions.** "Customer data is owned by the Customer context; other contexts reference it by ID only." The explicit no-s are as valuable as the yes-s.
|
||||||
- **Deliberate deviations from the obvious path.** "We're using manual SQL instead of an ORM because X." Anything where a reasonable reader would assume the opposite. These stop the next engineer from "fixing" something that was deliberate.
|
- **Deliberate deviations from the obvious path.** "We're using manual SQL instead of an ORM because X." Anything where a reasonable reader would assume the opposite. These stop the next engineer from "fixing" something that was deliberate.
|
||||||
- **Constraints not visible in the code.** "We can't use AWS because of compliance requirements." "Response times must be under 200ms because of the partner API contract."
|
- **Constraints not visible in the code.** "We can't use AWS because of compliance requirements." "Response times must be under 200ms because of the partner API contract."
|
||||||
- **Rejected alternatives when the rejection is non-obvious.** If you considered GraphQL and picked REST for subtle reasons, record it — otherwise someone will suggest GraphQL again in six months.
|
- **Rejected alternatives when the rejection is non-obvious.** If you considered GraphQL and picked REST for subtle reasons, record it; otherwise someone will suggest GraphQL again in six months.
|
||||||
@@ -40,9 +40,9 @@ _Avoid_: Client, buyer, account
|
|||||||
|
|
||||||
## Contexts
|
## Contexts
|
||||||
|
|
||||||
- [Ordering](./src/ordering/CONTEXT.md) — receives and tracks customer orders
|
- [Ordering](./src/ordering/CONTEXT.md): receives and tracks customer orders
|
||||||
- [Billing](./src/billing/CONTEXT.md) — generates invoices and processes payments
|
- [Billing](./src/billing/CONTEXT.md): generates invoices and processes payments
|
||||||
- [Fulfillment](./src/fulfillment/CONTEXT.md) — manages warehouse picking and shipping
|
- [Fulfillment](./src/fulfillment/CONTEXT.md): manages warehouse picking and shipping
|
||||||
|
|
||||||
## Relationships
|
## Relationships
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ description: Build and sharpen a project's domain model. Use when discussing cod
|
|||||||
|
|
||||||
# Domain Modeling
|
# Domain Modeling
|
||||||
|
|
||||||
Actively build and sharpen the project's domain model as you design. This is the *active* discipline — challenging terms, inventing edge-case scenarios, and writing the glossary and decisions down the moment they crystallise. (Merely *reading* `CONTEXT.md` for vocabulary is not this skill — that's a one-line habit any skill can do. This skill is for when you're changing the model, not just consuming it.)
|
Actively build and sharpen the project's domain model as you design. This is the *active* discipline: challenging terms, inventing edge-case scenarios, and writing the glossary and decisions down the moment they crystallise. (Merely *reading* `CONTEXT.md` for vocabulary is not this skill: that's a one-line habit any skill can do. This skill is for when you're changing the model, not just consuming it.)
|
||||||
|
|
||||||
## File structure
|
## File structure
|
||||||
|
|
||||||
@@ -37,17 +37,17 @@ If a `CONTEXT-MAP.md` exists at the root, the repo has multiple contexts. The ma
|
|||||||
│ └── docs/adr/
|
│ └── docs/adr/
|
||||||
```
|
```
|
||||||
|
|
||||||
Create files lazily — only when you have something to write. If no `CONTEXT.md` exists, create one when the first term is resolved. If no `docs/adr/` exists, create it when the first ADR is needed.
|
Create files lazily: only when you have something to write. If no `CONTEXT.md` exists, create one when the first term is resolved. If no `docs/adr/` exists, create it when the first ADR is needed.
|
||||||
|
|
||||||
## During the session
|
## During the session
|
||||||
|
|
||||||
### Challenge against the glossary
|
### Challenge against the glossary
|
||||||
|
|
||||||
When the user uses a term that conflicts with the existing language in `CONTEXT.md`, call it out immediately. "Your glossary defines 'cancellation' as X, but you seem to mean Y — which is it?"
|
When the user uses a term that conflicts with the existing language in `CONTEXT.md`, call it out immediately. "Your glossary defines 'cancellation' as X, but you seem to mean Y. Which is it?"
|
||||||
|
|
||||||
### Sharpen fuzzy language
|
### Sharpen fuzzy language
|
||||||
|
|
||||||
When the user uses vague or overloaded terms, propose a precise canonical term. "You're saying 'account' — do you mean the Customer or the User? Those are different things."
|
When the user uses vague or overloaded terms, propose a precise canonical term. "You're saying 'account': do you mean the Customer or the User? Those are different things."
|
||||||
|
|
||||||
### Discuss concrete scenarios
|
### Discuss concrete scenarios
|
||||||
|
|
||||||
@@ -55,11 +55,11 @@ When domain relationships are being discussed, stress-test them with specific sc
|
|||||||
|
|
||||||
### Cross-reference with code
|
### Cross-reference with code
|
||||||
|
|
||||||
When the user states how something works, check whether the code agrees. If you find a contradiction, surface it: "Your code cancels entire Orders, but you just said partial cancellation is possible — which is right?"
|
When the user states how something works, check whether the code agrees. If you find a contradiction, surface it: "Your code cancels entire Orders, but you just said partial cancellation is possible. Which is right?"
|
||||||
|
|
||||||
### Update CONTEXT.md inline
|
### Update CONTEXT.md inline
|
||||||
|
|
||||||
When a term is resolved, update `CONTEXT.md` right there. Don't batch these up — capture them as they happen. Use the format in [CONTEXT-FORMAT.md](./CONTEXT-FORMAT.md).
|
When a term is resolved, update `CONTEXT.md` right there. Don't batch these up: capture them as they happen. Use the format in [CONTEXT-FORMAT.md](./CONTEXT-FORMAT.md).
|
||||||
|
|
||||||
`CONTEXT.md` should be totally devoid of implementation details. Do not treat `CONTEXT.md` as a spec, a scratch pad, or a repository for implementation decisions. It is a glossary and nothing else.
|
`CONTEXT.md` should be totally devoid of implementation details. Do not treat `CONTEXT.md` as a spec, a scratch pad, or a repository for implementation decisions. It is a glossary and nothing else.
|
||||||
|
|
||||||
@@ -67,8 +67,8 @@ When a term is resolved, update `CONTEXT.md` right there. Don't batch these up
|
|||||||
|
|
||||||
Only offer to create an ADR when all three are true:
|
Only offer to create an ADR when all three are true:
|
||||||
|
|
||||||
1. **Hard to reverse** — the cost of changing your mind later is meaningful
|
1. **Hard to reverse**: the cost of changing your mind later is meaningful
|
||||||
2. **Surprising without context** — a future reader will wonder "why did they do it this way?"
|
2. **Surprising without context**: a future reader will wonder "why did they do it this way?"
|
||||||
3. **The result of a real trade-off** — there were genuine alternatives and you picked one for specific reasons
|
3. **The result of a real trade-off**: there were genuine alternatives and you picked one for specific reasons
|
||||||
|
|
||||||
If any of the three is missing, skip the ADR. Use the format in [ADR-FORMAT.md](./ADR-FORMAT.md).
|
If any of the three is missing, skip the ADR. Use the format in [ADR-FORMAT.md](./ADR-FORMAT.md).
|
||||||
@@ -78,7 +78,7 @@ Add to the appropriate settings file:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
If the settings file already exists, merge the hook into existing `hooks.PreToolUse` array — don't overwrite other settings.
|
If the settings file already exists, merge the hook into the existing `hooks.PreToolUse` array. Don't overwrite other settings.
|
||||||
|
|
||||||
### 4. Ask about customization
|
### 4. Ask about customization
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
# HTML Report Format
|
# HTML Report Format
|
||||||
|
|
||||||
The architectural review is rendered as a single self-contained HTML file in the OS temp directory. Tailwind and Mermaid both come from CDNs. Mermaid handles graph-shaped diagrams reliably; hand-built divs and inline SVG handle the more editorial visuals (mass diagrams, cross-sections). Mix the two — don't lean on Mermaid for everything, it'll start to look generic.
|
The architectural review is rendered as a single self-contained HTML file in the OS temp directory. Tailwind and Mermaid both come from CDNs. Mermaid handles graph-shaped diagrams reliably; hand-built divs and inline SVG handle the more editorial visuals (mass diagrams, cross-sections). Mix the two: don't lean on Mermaid for everything, it'll start to look generic.
|
||||||
|
|
||||||
## Scaffold
|
## Scaffold
|
||||||
|
|
||||||
@@ -9,7 +9,7 @@ The architectural review is rendered as a single self-contained HTML file in the
|
|||||||
<html lang="en">
|
<html lang="en">
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8" />
|
<meta charset="utf-8" />
|
||||||
<title>Architecture review — {{repo name}}</title>
|
<title>Architecture review for {{repo name}}</title>
|
||||||
<script src="https://cdn.tailwindcss.com"></script>
|
<script src="https://cdn.tailwindcss.com"></script>
|
||||||
<script type="module">
|
<script type="module">
|
||||||
import mermaid from "https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.esm.min.mjs";
|
import mermaid from "https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.esm.min.mjs";
|
||||||
@@ -35,7 +35,7 @@ The architectural review is rendered as a single self-contained HTML file in the
|
|||||||
|
|
||||||
## Header
|
## Header
|
||||||
|
|
||||||
Repo name, date, and a compact legend: solid box = module, dashed line = seam, red arrow = leakage, thick dark box = deep module. No introduction paragraph — straight into the candidates.
|
Repo name, date, and a compact legend: solid box = module, dashed line = seam, red arrow = leakage, thick dark box = deep module. No introduction paragraph. Straight into the candidates.
|
||||||
|
|
||||||
## Candidate card
|
## Candidate card
|
||||||
|
|
||||||
@@ -43,20 +43,20 @@ The diagrams carry the weight. Prose is sparse, plain, and uses the glossary ter
|
|||||||
|
|
||||||
Each candidate is one `<article>`:
|
Each candidate is one `<article>`:
|
||||||
|
|
||||||
- **Title** — short, names the deepening (e.g. "Collapse the Order intake pipeline").
|
- **Title**: short, names the deepening (e.g. "Collapse the Order intake pipeline").
|
||||||
- **Badge row** — recommendation strength (`Strong` = emerald, `Worth exploring` = amber, `Speculative` = slate), plus a tag for the dependency category (`in-process`, `local-substitutable`, `ports & adapters`, `mock`).
|
- **Badge row**: recommendation strength (`Strong` = emerald, `Worth exploring` = amber, `Speculative` = slate), plus a tag for the dependency category (`in-process`, `local-substitutable`, `ports & adapters`, `mock`).
|
||||||
- **Files** — monospaced list, `font-mono text-sm`.
|
- **Files**: monospaced list, `font-mono text-sm`.
|
||||||
- **Before / After diagram** — the centrepiece. Two columns, side by side. See patterns below.
|
- **Before / After diagram**: the centrepiece. Two columns, side by side. See patterns below.
|
||||||
- **Problem** — one sentence. What hurts.
|
- **Problem**: one sentence. What hurts.
|
||||||
- **Solution** — one sentence. What changes.
|
- **Solution**: one sentence. What changes.
|
||||||
- **Wins** — bullets, ≤6 words each. e.g. "Tests hit one interface", "Pricing logic stops leaking", "Delete 4 shallow wrappers".
|
- **Wins**: bullets, ≤6 words each. e.g. "Tests hit one interface", "Pricing logic stops leaking", "Delete 4 shallow wrappers".
|
||||||
- **ADR callout** (if applicable) — one line in an amber-tinted box.
|
- **ADR callout** (if applicable): one line in an amber-tinted box.
|
||||||
|
|
||||||
No paragraphs of explanation. If the diagram needs a paragraph to be understood, redraw the diagram.
|
No paragraphs of explanation. If the diagram needs a paragraph to be understood, redraw the diagram.
|
||||||
|
|
||||||
## Diagram patterns
|
## Diagram patterns
|
||||||
|
|
||||||
Pick the pattern that fits the candidate. Mix them. Don't make every diagram look the same — variety is part of the point.
|
Pick the pattern that fits the candidate. Mix them. Don't make every diagram look the same. Variety is part of the point.
|
||||||
|
|
||||||
### Mermaid graph (the workhorse for dependencies / call flow)
|
### Mermaid graph (the workhorse for dependencies / call flow)
|
||||||
|
|
||||||
@@ -77,7 +77,7 @@ Use a Mermaid `flowchart` or `graph` when the point is "X calls Y calls Z, and l
|
|||||||
|
|
||||||
### Hand-built boxes-and-arrows (when Mermaid's layout fights you)
|
### Hand-built boxes-and-arrows (when Mermaid's layout fights you)
|
||||||
|
|
||||||
Modules as `<div>`s with borders and labels. Arrows as inline SVG `<line>` or `<path>` elements positioned absolutely over a relative container. Reach for this when you want the "after" diagram to feel like one thick-bordered deep module with greyed-out internals — Mermaid won't render that with the right weight.
|
Modules as `<div>`s with borders and labels. Arrows as inline SVG `<line>` or `<path>` elements positioned absolutely over a relative container. Reach for this when you want the "after" diagram to feel like one thick-bordered deep module with greyed-out internals, since Mermaid won't render that with the right weight.
|
||||||
|
|
||||||
### Cross-section (good for layered shallowness)
|
### Cross-section (good for layered shallowness)
|
||||||
|
|
||||||
@@ -85,7 +85,7 @@ Stack horizontal bands (`h-12 border-l-4`) to show layers a call passes through.
|
|||||||
|
|
||||||
### Mass diagram (good for "interface as wide as implementation")
|
### Mass diagram (good for "interface as wide as implementation")
|
||||||
|
|
||||||
Two rectangles per module — one for interface surface area, one for implementation. Before: interface rectangle is nearly as tall as the implementation rectangle (shallow). After: interface rectangle is short, implementation rectangle is tall (deep).
|
Two rectangles per module: one for interface surface area, one for implementation. Before: interface rectangle is nearly as tall as the implementation rectangle (shallow). After: interface rectangle is short, implementation rectangle is tall (deep).
|
||||||
|
|
||||||
### Call-graph collapse
|
### Call-graph collapse
|
||||||
|
|
||||||
@@ -96,8 +96,8 @@ Before: a tree of function calls rendered as nested boxes. After: the same tree
|
|||||||
- Lean editorial, not corporate-dashboard. Generous whitespace. Serif optional for headings (`font-serif` works well with stone/slate).
|
- Lean editorial, not corporate-dashboard. Generous whitespace. Serif optional for headings (`font-serif` works well with stone/slate).
|
||||||
- Colour sparingly: one accent (emerald or indigo) plus red for leakage and amber for warnings.
|
- Colour sparingly: one accent (emerald or indigo) plus red for leakage and amber for warnings.
|
||||||
- Keep diagrams ~320px tall so before/after sits comfortably side by side without scrolling.
|
- Keep diagrams ~320px tall so before/after sits comfortably side by side without scrolling.
|
||||||
- Use `text-xs uppercase tracking-wider` for module labels inside diagrams — they should read as schematic, not as UI.
|
- Use `text-xs uppercase tracking-wider` for module labels inside diagrams, so they read as schematic, not as UI.
|
||||||
- The only scripts are the Tailwind CDN and the Mermaid ESM import. The report is otherwise static — no app code, no interactivity beyond Mermaid's own rendering.
|
- The only scripts are the Tailwind CDN and the Mermaid ESM import. The report is otherwise static: no app code, no interactivity beyond Mermaid's own rendering.
|
||||||
|
|
||||||
## Top recommendation section
|
## Top recommendation section
|
||||||
|
|
||||||
@@ -105,7 +105,7 @@ One larger card. Candidate name, one sentence on why, anchor link to its card. T
|
|||||||
|
|
||||||
## Tone
|
## Tone
|
||||||
|
|
||||||
Plain English, concise — but the architectural nouns and verbs come straight from the `/codebase-design` skill. Concision is not an excuse to drift.
|
Plain English, concise, but the architectural nouns and verbs come straight from the `/codebase-design` skill. Concision is not an excuse to drift.
|
||||||
|
|
||||||
**Use exactly:** module, interface, implementation, depth, deep, shallow, seam, adapter, leverage, locality.
|
**Use exactly:** module, interface, implementation, depth, deep, shallow, seam, adapter, leverage, locality.
|
||||||
|
|
||||||
@@ -113,11 +113,11 @@ Plain English, concise — but the architectural nouns and verbs come straight f
|
|||||||
|
|
||||||
**Phrasings that fit the style:**
|
**Phrasings that fit the style:**
|
||||||
|
|
||||||
- "Order intake module is shallow — interface nearly matches the implementation."
|
- "Order intake module is shallow: interface nearly matches the implementation."
|
||||||
- "Pricing leaks across the seam."
|
- "Pricing leaks across the seam."
|
||||||
- "Deepen: one interface, one place to test."
|
- "Deepen: one interface, one place to test."
|
||||||
- "Two adapters justify the seam: HTTP in prod, in-memory in tests."
|
- "Two adapters justify the seam: HTTP in prod, in-memory in tests."
|
||||||
|
|
||||||
**Wins bullets** name the gain in glossary terms: *"locality: bugs concentrate in one module"*, *"leverage: one interface, N call sites"*, *"interface shrinks; implementation absorbs the wrappers"*. Don't write *"easier to maintain"* or *"cleaner code"* — those terms aren't in the glossary and don't earn their place.
|
**Wins bullets** name the gain in glossary terms: *"locality: bugs concentrate in one module"*, *"leverage: one interface, N call sites"*, *"interface shrinks; implementation absorbs the wrappers"*. Don't write *"easier to maintain"* or *"cleaner code"*, because those terms aren't in the glossary and don't earn their place.
|
||||||
|
|
||||||
No hedging, no throat-clearing, no "it's worth noting that…". If a sentence could be a bullet, make it a bullet. If a bullet could be cut, cut it. If a term isn't in the `/codebase-design` glossary, reach for one that is before inventing a new one.
|
No hedging, no throat-clearing, no "it's worth noting that…". If a sentence could be a bullet, make it a bullet. If a bullet could be cut, cut it. If a term isn't in the `/codebase-design` glossary, reach for one that is before inventing a new one.
|
||||||
@@ -6,28 +6,28 @@ disable-model-invocation: true
|
|||||||
|
|
||||||
# Improve Codebase Architecture
|
# Improve Codebase Architecture
|
||||||
|
|
||||||
Surface architectural friction and propose **deepening opportunities** — refactors that turn shallow modules into deep ones. The aim is testability and AI-navigability.
|
Surface architectural friction and propose **deepening opportunities**: refactors that turn shallow modules into deep ones. The aim is testability and AI-navigability.
|
||||||
|
|
||||||
This command is _informed_ by the project's domain model and built on a shared design vocabulary:
|
This command is _informed_ by the project's domain model and built on a shared design vocabulary:
|
||||||
|
|
||||||
- Call the Skill tool with "codebase-design" for the architecture vocabulary (**module**, **interface**, **depth**, **seam**, **adapter**, **leverage**, **locality**) and its principles (the deletion test, "the interface is the test surface", "one adapter = hypothetical seam, two = real"). Use these terms exactly in every suggestion — don't drift into "component," "service," "API," or "boundary."
|
- Call the Skill tool with "codebase-design" for the architecture vocabulary (**module**, **interface**, **depth**, **seam**, **adapter**, **leverage**, **locality**) and its principles (the deletion test, "the interface is the test surface", "one adapter = hypothetical seam, two = real"). Use these terms exactly in every suggestion, and don't drift into "component," "service," "API," or "boundary."
|
||||||
- The domain language in `CONTEXT.md` gives names to good seams; ADRs in `docs/adr/` record decisions this command should not re-litigate.
|
- The domain language in `CONTEXT.md` gives names to good seams; ADRs in `docs/adr/` record decisions this command should not re-litigate.
|
||||||
|
|
||||||
## Process
|
## Process
|
||||||
|
|
||||||
### 1. Explore
|
### 1. Explore
|
||||||
|
|
||||||
**Scope before you scan — YAGNI.** Deepening a module pays off by making future changes to it easier, so put extra weight on the parts of the codebase that have recently changed. Decide *where* to look before you look:
|
**Scope before you scan: YAGNI.** Deepening a module pays off by making future changes to it easier, so put extra weight on the parts of the codebase that have recently changed. Decide *where* to look before you look:
|
||||||
|
|
||||||
- If the user named a direction — a module, a subsystem, a pain point — take it, and skip the inference below.
|
- If the user named a direction (a module, a subsystem, a pain point), take it, and skip the inference below.
|
||||||
- Otherwise, walk back a good stretch of the commit history (`git log --oneline`) to find the codebase's hot spots — the files and areas that keep coming up — and let those paths pull your attention first. If the changes are scattered with no clear hot spot, widen the net.
|
- Otherwise, walk back a good stretch of the commit history (`git log --oneline`) to find the codebase's hot spots, the files and areas that keep coming up, and let those paths pull your attention first. If the changes are scattered with no clear hot spot, widen the net.
|
||||||
|
|
||||||
Read the project's domain glossary (`CONTEXT.md`) and any ADRs in the area you're touching first.
|
Read the project's domain glossary (`CONTEXT.md`) and any ADRs in the area you're touching first.
|
||||||
|
|
||||||
Then spawn a sub-agent to walk the codebase. Don't follow rigid heuristics — explore organically and note where you experience friction:
|
Then spawn a sub-agent to walk the codebase. Don't follow rigid heuristics; explore organically and note where you experience friction:
|
||||||
|
|
||||||
- Where does understanding one concept require bouncing between many small modules?
|
- Where does understanding one concept require bouncing between many small modules?
|
||||||
- Where are modules **shallow** — interface nearly as complex as the implementation?
|
- Where are modules **shallow**, with an interface nearly as complex as the implementation?
|
||||||
- Where have pure functions been extracted just for testability, but the real bugs hide in how they're called (no **locality**)?
|
- Where have pure functions been extracted just for testability, but the real bugs hide in how they're called (no **locality**)?
|
||||||
- Where do tightly-coupled modules leak across their seams?
|
- Where do tightly-coupled modules leak across their seams?
|
||||||
- Which parts of the codebase are untested, or hard to test through their current interface?
|
- Which parts of the codebase are untested, or hard to test through their current interface?
|
||||||
@@ -36,24 +36,24 @@ Apply the **deletion test** to anything you suspect is shallow: would deleting i
|
|||||||
|
|
||||||
### 2. Present candidates as an HTML report
|
### 2. Present candidates as an HTML report
|
||||||
|
|
||||||
Write a self-contained HTML file to the OS temp directory so nothing lands in the repo. Resolve the temp dir from `$TMPDIR`, falling back to `/tmp` (or `%TEMP%` on Windows), and write to `<tmpdir>/architecture-review-<timestamp>.html` so each run gets a fresh file. Open it for the user — `xdg-open <path>` on Linux, `open <path>` on macOS, `start <path>` on Windows — and tell them the absolute path.
|
Write a self-contained HTML file to the OS temp directory so nothing lands in the repo. Resolve the temp dir from `$TMPDIR`, falling back to `/tmp` (or `%TEMP%` on Windows), and write to `<tmpdir>/architecture-review-<timestamp>.html` so each run gets a fresh file. Open it for the user (`xdg-open <path>` on Linux, `open <path>` on macOS, `start <path>` on Windows) and tell them the absolute path.
|
||||||
|
|
||||||
The report uses **Tailwind via CDN** for layout and styling, and **Mermaid via CDN** for diagrams where a graph/flow/sequence reliably communicates the structure. Mix Mermaid with hand-crafted CSS/SVG visuals — use Mermaid when relationships are graph-shaped (call graphs, dependencies, sequences), and hand-built divs/SVG when you want something more editorial (mass diagrams, cross-sections, collapse animations). Each candidate gets a **before/after visualisation**. Be visual.
|
The report uses **Tailwind via CDN** for layout and styling, and **Mermaid via CDN** for diagrams where a graph/flow/sequence reliably communicates the structure. Mix Mermaid with hand-crafted CSS/SVG visuals: use Mermaid when relationships are graph-shaped (call graphs, dependencies, sequences), and hand-built divs/SVG when you want something more editorial (mass diagrams, cross-sections, collapse animations). Each candidate gets a **before/after visualisation**. Be visual.
|
||||||
|
|
||||||
For each candidate, render a card with:
|
For each candidate, render a card with:
|
||||||
|
|
||||||
- **Files** — which files/modules are involved
|
- **Files**: which files/modules are involved
|
||||||
- **Problem** — why the current architecture is causing friction
|
- **Problem**: why the current architecture is causing friction
|
||||||
- **Solution** — plain English description of what would change
|
- **Solution**: plain English description of what would change
|
||||||
- **Benefits** — explained in terms of locality and leverage, and how tests would improve
|
- **Benefits**: explained in terms of locality and leverage, and how tests would improve
|
||||||
- **Before / After diagram** — side-by-side, custom-drawn, illustrating the shallowness and the deepening
|
- **Before / After diagram**: side-by-side, custom-drawn, illustrating the shallowness and the deepening
|
||||||
- **Recommendation strength** — one of `Strong`, `Worth exploring`, `Speculative`, rendered as a badge
|
- **Recommendation strength**: one of `Strong`, `Worth exploring`, `Speculative`, rendered as a badge
|
||||||
|
|
||||||
End the report with a **Top recommendation** section: which candidate you'd tackle first and why.
|
End the report with a **Top recommendation** section: which candidate you'd tackle first and why.
|
||||||
|
|
||||||
**Use CONTEXT.md vocabulary for the domain, and the `/codebase-design` vocabulary for the architecture.** If `CONTEXT.md` defines "Order," talk about "the Order intake module" — not "the FooBarHandler," and not "the Order service."
|
**Use CONTEXT.md vocabulary for the domain, and the `/codebase-design` vocabulary for the architecture.** If `CONTEXT.md` defines "Order," talk about "the Order intake module," not "the FooBarHandler," and not "the Order service."
|
||||||
|
|
||||||
**ADR conflicts**: if a candidate contradicts an existing ADR, only surface it when the friction is real enough to warrant revisiting the ADR. Mark it clearly in the card (e.g. a warning callout: _"contradicts ADR-0007 — but worth reopening because…"_). Don't list every theoretical refactor an ADR forbids.
|
**ADR conflicts**: if a candidate contradicts an existing ADR, only surface it when the friction is real enough to warrant revisiting the ADR. Mark it clearly in the card (e.g. a warning callout: _"contradicts ADR-0007, but worth reopening because…"_). Don't list every theoretical refactor an ADR forbids.
|
||||||
|
|
||||||
See [HTML-REPORT.md](HTML-REPORT.md) for the full HTML scaffold, diagram patterns, and styling guidance.
|
See [HTML-REPORT.md](HTML-REPORT.md) for the full HTML scaffold, diagram patterns, and styling guidance.
|
||||||
|
|
||||||
@@ -61,11 +61,11 @@ Do NOT propose interfaces yet. After the file is written, ask the user: "Which o
|
|||||||
|
|
||||||
### 3. Grilling loop
|
### 3. Grilling loop
|
||||||
|
|
||||||
Once the user picks a candidate, call the Skill tool with "grilling" to walk the decision tree with them — constraints, dependencies, the shape of the deepened module, what sits behind the seam, what tests survive.
|
Once the user picks a candidate, call the Skill tool with "grilling" to walk the decision tree with them: constraints, dependencies, the shape of the deepened module, what sits behind the seam, what tests survive.
|
||||||
|
|
||||||
Side effects happen inline as decisions crystallize — call the Skill tool with "domain-modeling" to keep the domain model current as you go:
|
Side effects happen inline as decisions crystallize; call the Skill tool with "domain-modeling" to keep the domain model current as you go:
|
||||||
|
|
||||||
- **Naming a deepened module after a concept not in `CONTEXT.md`?** Add the term to `CONTEXT.md`. Create the file lazily if it doesn't exist.
|
- **Naming a deepened module after a concept not in `CONTEXT.md`?** Add the term to `CONTEXT.md`. Create the file lazily if it doesn't exist.
|
||||||
- **Sharpening a fuzzy term during the conversation?** Update `CONTEXT.md` right there.
|
- **Sharpening a fuzzy term during the conversation?** Update `CONTEXT.md` right there.
|
||||||
- **User rejects the candidate with a load-bearing reason?** Offer an ADR, framed as: _"Want me to record this as an ADR so future architecture reviews don't re-suggest it?"_ Only offer when the reason would actually be needed by a future explorer to avoid re-suggesting the same thing — skip ephemeral reasons ("not worth it right now") and self-evident ones.
|
- **User rejects the candidate with a load-bearing reason?** Offer an ADR, framed as: _"Want me to record this as an ADR so future architecture reviews don't re-suggest it?"_ Only offer when the reason would actually be needed by a future explorer to avoid re-suggesting the same thing; skip ephemeral reasons ("not worth it right now") and self-evident ones.
|
||||||
- **Want to explore alternative interfaces for the deepened module?** Call the Skill tool with "codebase-design" and use its design-it-twice parallel sub-agent pattern.
|
- **Want to explore alternative interfaces for the deepened module?** Call the Skill tool with "codebase-design" and use its design-it-twice parallel sub-agent pattern.
|
||||||
@@ -5,22 +5,22 @@ disable-model-invocation: true
|
|||||||
argument-hint: "A workflow to design, or nothing to go find one"
|
argument-hint: "A workflow to design, or nothing to go find one"
|
||||||
---
|
---
|
||||||
|
|
||||||
Run a stateful `/grilling` session whose only output is **workflow** specs. Use the grilling discipline — relentless, a round of questions at a time, a recommended answer attached to each — aimed at the vocabulary and goal below. Create, edit, and delete specs as the grilling resolves things.
|
Run a stateful `/grilling` session whose only output is **workflow** specs. Use the grilling discipline (relentless, a round of questions at a time, a recommended answer attached to each) aimed at the vocabulary and goal below. Create, edit, and delete specs as the grilling resolves things.
|
||||||
|
|
||||||
## The loop lens
|
## The loop lens
|
||||||
|
|
||||||
A **loop** is a recurring pattern in the user's life: their career, their week, their morning, a single repeated activity. Picturing a life as loops within loops reveals how predictable its activities really are — which is what makes them worth **delegating**. Use the lens to find loops worth specifying, and propose ones the user hasn't noticed.
|
A **loop** is a recurring pattern in the user's life: their career, their week, their morning, a single repeated activity. Picturing a life as loops within loops reveals how predictable its activities really are, which is what makes them worth **delegating**. Use the lens to find loops worth specifying, and propose ones the user hasn't noticed.
|
||||||
|
|
||||||
A **workflow** is the spec of one loop, made real. You run a workflow on a loop — the loop is its running instantiation. Workflows live in `workflows/*.md` and are the source of truth.
|
A **workflow** is the spec of one loop, made real. You run a workflow on a loop: the loop is its running instantiation. Workflows live in `workflows/*.md` and are the source of truth.
|
||||||
|
|
||||||
## Vocabulary
|
## Vocabulary
|
||||||
|
|
||||||
A shared language, reached for only when a workflow calls for it — never a checklist. **Mandate nothing structural**: a workflow needs no AI, no checkpoint, and no schedule unless the grilling shows it does.
|
A shared language, reached for only when a workflow calls for it: never a checklist. **Mandate nothing structural**: a workflow needs no AI, no checkpoint, and no schedule unless the grilling shows it does.
|
||||||
|
|
||||||
- **Trigger** — what fires each run: an **event** (a new email, a new issue) or a **schedule** (every morning). Event-triggering is usually the more efficient.
|
- **Trigger**: what fires each run, an **event** (a new email, a new issue) or a **schedule** (every morning). Event-triggering is usually the more efficient.
|
||||||
- **Checkpoint** — a human-in-the-loop point where the user is asked to verify or decide. Some workflows have none and run autonomously; some use no AI at all.
|
- **Checkpoint**: a human-in-the-loop point where the user is asked to verify or decide. Some workflows have none and run autonomously; some use no AI at all.
|
||||||
- **Push right** — defer the checkpoint as far as it will go. Do maximal work before involving the human, so they are asked once, late, with everything prepared.
|
- **Push right**: defer the checkpoint as far as it will go. Do maximal work before involving the human, so they are asked once, late, with everything prepared.
|
||||||
- **Brief** — what a checkpoint presents: a tight, decision-ready summary — what was produced, why, and a link down to the asset itself — never the raw output. The user reads a brief, not a draft. Speed of review is imperative.
|
- **Brief**: what a checkpoint presents, a tight, decision-ready summary (what was produced, why, and a link down to the asset itself), never the raw output. The user reads a brief, not a draft. Speed of review is imperative.
|
||||||
|
|
||||||
## Definition of done
|
## Definition of done
|
||||||
|
|
||||||
@@ -28,5 +28,5 @@ A workflow spec is done when an implementer agent could build it without asking
|
|||||||
|
|
||||||
## The workspace
|
## The workspace
|
||||||
|
|
||||||
- `workflows/*.md` — one spec per workflow.
|
- `workflows/*.md`: one spec per workflow.
|
||||||
- `NOTES.md` — raw notes on the user's world: the tools they use, the channels they process, and their own terminology for both. When it is empty or thin, interview them about their world before specifying anything. Sharpen fuzzy terms into canonical ones as they surface, and record them here.
|
- `NOTES.md`: raw notes on the user's world, the tools they use, the channels they process, and their own terminology for both. When it is empty or thin, interview them about their world before specifying anything. Sharpen fuzzy terms into canonical ones as they surface, and record them here.
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
name: native-sdk
|
name: native-sdk
|
||||||
description: Discovery skill for the Native SDK, the complete toolkit for building native desktop applications. Apps are authored in TypeScript + declarative Native markup (.native) by default and compiled to native code with no JS runtime in the binary; Zig cores are an explicit alternative, and WebViews are the optional web-content path. Use when the user asks what the Native SDK is, how to build a Native SDK app, author native UI, scaffold an app, configure app.zon, add bridge commands, embed web content, package an app, test a running app, or automate a Native SDK app.
|
description: Discovery skill for the Native SDK, the complete toolkit for building native desktop applications. Apps are authored in TypeScript + declarative Native markup (.native) by default and compiled to native code with no JS runtime in the binary; Zig cores are an explicit alternative, and WebViews are the optional web-content path. Use when the user asks what the Native SDK is, how to build a Native SDK app, author native UI, scaffold an app, configure app.json or legacy app.zon, add bridge commands, embed web content, package an app, test a running app, or automate a Native SDK app.
|
||||||
allowed-tools: Bash(native:*), Bash(npx @native-sdk/cli:*)
|
allowed-tools: Bash(native:*), Bash(npx @native-sdk/cli:*)
|
||||||
hidden: true
|
hidden: true
|
||||||
---
|
---
|
||||||
@@ -20,7 +20,7 @@ native skills get native-ui
|
|||||||
native skills get ts-core
|
native skills get ts-core
|
||||||
```
|
```
|
||||||
|
|
||||||
Use `native skills get core` for initial orientation. For the default app-authoring path, load **both** `native-ui` (views, bindings, the app loop) and `ts-core` (the TypeScript subset, effects, subscriptions, and modules) before implementing. Use `native skills get core --full` when work reaches lower-level runtime wiring, WebViews, bridge/security, native capabilities, packaging, or debugging. Use `native skills get automation` when testing a running app, taking snapshots, requesting reloads, or using the built-in automation server. Use `native skills get zig` only for an existing Zig core, a toolkit extension, SDK implementation work, or a Zig 0.16 compile error.
|
Use `native skills get core` for initial orientation. For the default app-authoring path, load **both** `native-ui` (views, bindings, the app loop) and `ts-core` (the TypeScript subset, effects, subscriptions, and modules) before implementing. Load `ts-services` too when the tree has `src/services/` or ordinary TypeScript needs filesystem/process/JSON/regex/Map/Date/class work behind `Cmd.request`. Use `native skills get core --full` when work reaches lower-level runtime wiring, WebViews, bridge/security, native capabilities, packaging, or debugging. Use `native skills get automation` when testing a running app, taking snapshots, requesting reloads, or using the built-in automation server. Use `native skills get zig` only for an existing Zig core, a toolkit extension, SDK implementation work, or a Zig 0.16 compile error.
|
||||||
|
|
||||||
## Quick orientation
|
## Quick orientation
|
||||||
|
|
||||||
@@ -31,4 +31,4 @@ cd my_app
|
|||||||
native dev
|
native dev
|
||||||
```
|
```
|
||||||
|
|
||||||
`native init my_app` generates the primary three-file app: `app.zon`, `src/app.native` (the markup view), and `src/core.ts` (`Model`, `Msg`, `update`). Inspect the tree before editing an existing app and preserve the core language it already uses. `src/main.zig` means the app explicitly uses the Zig-core template; web-frontend shells additionally carry `frontend/` and usually owned build/runtime wiring.
|
`native init my_app` generates the primary three-file app: `app.json`, `src/app.native` (the markup view), and `src/core.ts` (`Model`, `Msg`, `update`). Existing `app.zon` manifests remain supported. Inspect the tree before editing an existing app and preserve the core language it already uses. `src/main.zig` means the app explicitly uses the Zig-core template; web-frontend shells additionally carry `frontend/` and usually owned build/runtime wiring.
|
||||||
@@ -1,8 +1,8 @@
|
|||||||
# Logic Prototype
|
# Logic Prototype
|
||||||
|
|
||||||
A single, self-contained HTML file — a **shareable demo** — that lets anyone drive a state model by clicking buttons. Use this when the question is about **business logic, state transitions, or data shape** — the kind of thing that looks reasonable on paper but only feels wrong once you push it through real cases.
|
A single, self-contained HTML file (a **shareable demo**) that lets anyone drive a state model by clicking buttons. Use this when the question is about **business logic, state transitions, or data shape**: the kind of thing that looks reasonable on paper but only feels wrong once you push it through real cases.
|
||||||
|
|
||||||
Because it's one file with nothing to install, you can hand it to a non-developer — a designer, a PM, a domain expert — and let them feel the model for themselves. So it speaks their language, not the code's.
|
Because it's one file with nothing to install, you can hand it to a non-developer (a designer, a PM, a domain expert) and let them feel the model for themselves. So it speaks their language, not the code's.
|
||||||
|
|
||||||
## When this is the right shape
|
## When this is the right shape
|
||||||
|
|
||||||
@@ -11,51 +11,51 @@ Because it's one file with nothing to install, you can hand it to a non-develope
|
|||||||
- "I want to feel out what the API should look like before writing it."
|
- "I want to feel out what the API should look like before writing it."
|
||||||
- Anything where someone wants to **press buttons and watch state change**.
|
- Anything where someone wants to **press buttons and watch state change**.
|
||||||
|
|
||||||
If the question is "what should this look like" — wrong branch. Use [UI.md](UI.md).
|
If the question is "what should this look like," this is the wrong branch. Use [UI.md](UI.md).
|
||||||
|
|
||||||
## Process
|
## Process
|
||||||
|
|
||||||
### 1. State the question
|
### 1. State the question
|
||||||
|
|
||||||
Before writing code, write down what state model and what question you're prototyping. One paragraph, at the top of the demo (in a visible intro, not just a comment). A logic prototype that answers the wrong question is pure waste — make the question explicit so it can be checked later, whether the user is watching now or returning to it AFK.
|
Before writing code, write down what state model and what question you're prototyping. One paragraph, at the top of the demo (in a visible intro, not just a comment). A logic prototype that answers the wrong question is pure waste, so make the question explicit so it can be checked later, whether the user is watching now or returning to it AFK.
|
||||||
|
|
||||||
### 2. Isolate the logic in a portable module
|
### 2. Isolate the logic in a portable module
|
||||||
|
|
||||||
Put the actual logic — the bit that's answering the question — in a single `<script>` block written as a small, pure module that could be lifted out and dropped into the real codebase later. The page around it is throwaway; this module isn't.
|
Put the actual logic (the bit that's answering the question) in a single `<script>` block written as a small, pure module that could be lifted out and dropped into the real codebase later. The page around it is throwaway; this module isn't.
|
||||||
|
|
||||||
The right shape depends on the question:
|
The right shape depends on the question:
|
||||||
|
|
||||||
- **A pure reducer** — `(state, action) => state`. Good when actions are discrete events and state is a single value.
|
- **A pure reducer**: `(state, action) => state`. Good when actions are discrete events and state is a single value.
|
||||||
- **A state machine** — explicit states and transitions. Good when "which actions are even legal right now" is part of the question.
|
- **A state machine**: explicit states and transitions. Good when "which actions are even legal right now" is part of the question.
|
||||||
- **A small set of pure functions** over a plain data type. Good when there's no implicit current state — just transformations.
|
- **A small set of pure functions** over a plain data type. Good when there's no implicit current state, just transformations.
|
||||||
- **A class or module with a clear method surface** when the logic genuinely owns ongoing internal state.
|
- **A class or module with a clear method surface** when the logic genuinely owns ongoing internal state.
|
||||||
|
|
||||||
Pick whichever shape best fits the question being asked, *not* whichever is easiest to wire to a page. Keep it pure: no DOM, no `document`, no button handlers reaching inside it. The page calls into it; nothing flows the other direction. This is what makes the prototype useful past its own lifetime: once the question's answered, the validated reducer / machine / function set lifts into the real module on its own.
|
Pick whichever shape best fits the question being asked, *not* whichever is easiest to wire to a page. Keep it pure: no DOM, no `document`, no button handlers reaching inside it. The page calls into it; nothing flows the other direction. This is what makes the prototype useful past its own lifetime: once the question's answered, the validated reducer / machine / function set lifts into the real module on its own.
|
||||||
|
|
||||||
### 3. Build the shareable HTML file
|
### 3. Build the shareable HTML file
|
||||||
|
|
||||||
One file, plain HTML/CSS/JS — no framework, no bundler, no server, everything inline so it opens by double-click and survives being emailed around. Anyone should be able to run it by opening it.
|
One file, plain HTML/CSS/JS: no framework, no bundler, no server, everything inline so it opens by double-click and survives being emailed around. Anyone should be able to run it by opening it.
|
||||||
|
|
||||||
Write it for a non-developer. Every label is in **domain language**, not code — buttons and state read like the business, not the reducer. Explain in plain words what's happening.
|
Write it for a non-developer. Every label is in **domain language**, not code: buttons and state read like the business, not the reducer. Explain in plain words what's happening.
|
||||||
|
|
||||||
Lay it out with a clean hierarchy, top to bottom:
|
Lay it out with a clean hierarchy, top to bottom:
|
||||||
|
|
||||||
1. **Title and one-line explanation** of what this demo lets you explore (the question from step 1).
|
1. **Title and one-line explanation** of what this demo lets you explore (the question from step 1).
|
||||||
2. **Current state** — the full relevant state, rendered as a readable panel (labelled fields, not a raw JSON dump), re-rendered after every click so the change is visible. Where it helps a non-developer follow, call out what just changed.
|
2. **Current state**: the full relevant state, rendered as a readable panel (labelled fields, not a raw JSON dump), re-rendered after every click so the change is visible. Where it helps a non-developer follow, call out what just changed.
|
||||||
3. **Free-play buttons** — one button per action, always available, so anyone can poke at the model in any order. Each click dispatches its action and re-renders the state.
|
3. **Free-play buttons**: one button per action, always available, so anyone can poke at the model in any order. Each click dispatches its action and re-renders the state.
|
||||||
4. **Guided walkthroughs** — a set of **scenarios**, one per tab. Each tab holds a short plain-language description of the scenario — the situation it sets up and what to watch for — and underneath it, the ordered **buttons to press** for that scenario. Each step is a real button: clicking it performs that action and moves to the next step. Starting a walkthrough resets to a known initial state so the scenario runs the same way every time.
|
4. **Guided walkthroughs**: a set of **scenarios**, one per tab. Each tab holds a short plain-language description of the scenario (the situation it sets up and what to watch for) and underneath it, the ordered **buttons to press** for that scenario. Each step is a real button: clicking it performs that action and moves to the next step. Starting a walkthrough resets to a known initial state so the scenario runs the same way every time.
|
||||||
|
|
||||||
Choose scenarios that demonstrate the awkward cases — the happy path, a tricky edge case, an attempt at something that should be illegal — the ones hard to reason about on paper.
|
Choose scenarios that demonstrate the awkward cases, the ones hard to reason about on paper: the happy path, a tricky edge case, an attempt at something that should be illegal.
|
||||||
|
|
||||||
Keep it beautiful but restrained: clean typography, generous spacing, one accent colour. No animations, no gimmicks — nothing that competes with the state and the buttons.
|
Keep it beautiful but restrained: clean typography, generous spacing, one accent colour. No animations, no gimmicks: nothing that competes with the state and the buttons.
|
||||||
|
|
||||||
### 4. Hand it over
|
### 4. Hand it over
|
||||||
|
|
||||||
Send them the file, or open it for them. They'll click through the walkthroughs and free-play whenever they get to it; the interesting moments are when they say "wait, that shouldn't be possible" or "huh, I assumed X would be different" — those are the bugs in the _idea_, which is the whole point. If they want new actions or a new scenario, add them. Prototypes evolve.
|
Send them the file, or open it for them. They'll click through the walkthroughs and free-play whenever they get to it; the interesting moments are when they say "wait, that shouldn't be possible" or "huh, I assumed X would be different"; those are the bugs in the _idea_, which is the whole point. If they want new actions or a new scenario, add them. Prototypes evolve.
|
||||||
|
|
||||||
### 5. Capture the answer and the prototype
|
### 5. Capture the answer and the prototype
|
||||||
|
|
||||||
Once the prototype has answered its question, capture the answer, then capture the prototype the way the [SKILL](SKILL.md) describes. The logic-specific mapping: the validated reducer / machine / function set lifts into the real module (the decision, absorbed); the HTML shell rides along to the throwaway branch that keeps the prototype as a primary source — and being one self-contained file, it stays trivially re-runnable there.
|
Once the prototype has answered its question, capture the answer, then capture the prototype the way the [SKILL](SKILL.md) describes. The logic-specific mapping: the validated reducer / machine / function set lifts into the real module (the decision, absorbed); the HTML shell rides along to the throwaway branch that keeps the prototype as a primary source, and being one self-contained file, it stays trivially re-runnable there.
|
||||||
|
|
||||||
## Anti-patterns
|
## Anti-patterns
|
||||||
|
|
||||||
|
|||||||
@@ -9,18 +9,18 @@ A prototype is **throwaway code that answers a question**. The question decides
|
|||||||
|
|
||||||
## Pick a branch
|
## Pick a branch
|
||||||
|
|
||||||
Identify which question is being answered — from the user's prompt, the surrounding code, or by asking if the user is around:
|
Identify which question is being answered, using the user's prompt, the surrounding code, or by asking if the user is around:
|
||||||
|
|
||||||
- **"Does this logic / state model feel right?"** → [LOGIC.md](LOGIC.md). Build a single shareable HTML file — free-play buttons plus tabbed guided walkthroughs — that pushes the state machine through cases that are hard to reason about on paper, and that a non-developer can drive.
|
- **"Does this logic / state model feel right?"** → [LOGIC.md](LOGIC.md). Build a single shareable HTML file (free-play buttons plus tabbed guided walkthroughs) that pushes the state machine through cases that are hard to reason about on paper, and that a non-developer can drive.
|
||||||
- **"What should this look like?"** → [UI.md](UI.md). Generate several radically different UI variations on a single route, switchable via a URL search param and a floating bottom bar.
|
- **"What should this look like?"** → [UI.md](UI.md). Generate several radically different UI variations on a single route, switchable via a URL search param and a floating bottom bar.
|
||||||
|
|
||||||
The two branches produce very different artifacts — getting this wrong wastes the whole prototype. If the question is genuinely ambiguous and the user isn't reachable, default to whichever branch better matches the surrounding code (a backend module → logic; a page or component → UI) and state the assumption at the top of the prototype.
|
The two branches produce very different artifacts, so getting this wrong wastes the whole prototype. If the question is genuinely ambiguous and the user isn't reachable, default to whichever branch better matches the surrounding code (a backend module → logic; a page or component → UI) and state the assumption at the top of the prototype.
|
||||||
|
|
||||||
## Rules that apply to both
|
## Rules that apply to both
|
||||||
|
|
||||||
1. **Throwaway from day one, and clearly marked as such.** Locate the prototype code close to where it will actually be used (next to the module or page it's prototyping for) so context is obvious — but name it so a casual reader can see it's a prototype, not production. For throwaway UI routes, obey whatever routing convention the project already uses; don't invent a new top-level structure.
|
1. **Throwaway from day one, and clearly marked as such.** Locate the prototype code close to where it will actually be used (next to the module or page it's prototyping for) so context is obvious, but name it so a casual reader can see it's a prototype, not production. For throwaway UI routes, obey whatever routing convention the project already uses; don't invent a new top-level structure.
|
||||||
2. **Trivial to run.** A UI prototype starts from one command in the project's task runner — `pnpm <name>`, `python <path>`, `bun <path>`, etc. A logic demo is a single HTML file the user double-clicks. Either way, no thinking required to start it.
|
2. **Trivial to run.** A UI prototype starts from one command in the project's task runner: `pnpm <name>`, `python <path>`, `bun <path>`, etc. A logic demo is a single HTML file the user double-clicks. Either way, no thinking required to start it.
|
||||||
3. **No persistence by default.** State lives in memory. Persistence is the thing the prototype is _checking_, not something it should depend on. If the question explicitly involves a database, hit a scratch DB or a local file with a clear "PROTOTYPE — wipe me" name.
|
3. **No persistence by default.** State lives in memory. Persistence is the thing the prototype is _checking_, not something it should depend on. If the question explicitly involves a database, hit a scratch DB or a local file with a clear "PROTOTYPE, wipe me" name.
|
||||||
4. **Skip the polish.** No tests, no error handling beyond what makes the prototype _runnable_, no abstractions. The point is to learn something fast.
|
4. **Skip the polish.** No tests, no error handling beyond what makes the prototype _runnable_, no abstractions. The point is to learn something fast.
|
||||||
5. **Surface the state.** After every action (logic) or on every variant switch (UI), print or render the full relevant state so the user can see what changed.
|
5. **Surface the state.** After every action (logic) or on every variant switch (UI), print or render the full relevant state so the user can see what changed.
|
||||||
6. **Capture it when done.** Fold any validated decision into the real code, then capture the prototype itself as a **primary source**: commit it to a throwaway branch, out of main, and leave a context pointer to that branch on the implementation issue. Capture the answer too — the verdict and the question it settled — in the issue or a commit. The main branch keeps only the validated decision.
|
6. **Capture it when done.** Fold any validated decision into the real code, then capture the prototype itself as a **primary source**: commit it to a throwaway branch, out of main, and leave a context pointer to that branch on the implementation issue. Capture the answer too (the verdict and the question it settled) in the issue or a commit. The main branch keeps only the validated decision.
|
||||||
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Generate **several radically different UI variations** on a single route, switchable from a floating bottom bar. The user flips between variants in the browser, picks one (or steals bits from each), then throws the rest away.
|
Generate **several radically different UI variations** on a single route, switchable from a floating bottom bar. The user flips between variants in the browser, picks one (or steals bits from each), then throws the rest away.
|
||||||
|
|
||||||
If the question is about logic/state rather than what something looks like — wrong branch. Use [LOGIC.md](LOGIC.md).
|
If the question is about logic/state rather than what something looks like, this is the wrong branch. Use [LOGIC.md](LOGIC.md).
|
||||||
|
|
||||||
## When this is the right shape
|
## When this is the right shape
|
||||||
|
|
||||||
@@ -11,21 +11,21 @@ If the question is about logic/state rather than what something looks like — w
|
|||||||
- "Try a different layout for the settings screen."
|
- "Try a different layout for the settings screen."
|
||||||
- Any time the user would otherwise spend a day picking between three vague mockups in their head.
|
- Any time the user would otherwise spend a day picking between three vague mockups in their head.
|
||||||
|
|
||||||
## Two sub-shapes — strongly prefer sub-shape A
|
## Two sub-shapes: strongly prefer sub-shape A
|
||||||
|
|
||||||
A UI prototype is much easier to judge when it's **butting up against the rest of the app** — real header, real sidebar, real data, real density. A throwaway route on its own is a vacuum: every variant looks fine in isolation. Default to sub-shape A whenever there's a plausible existing page to host the variants. Only reach for sub-shape B if the prototype genuinely has no nearby home.
|
A UI prototype is much easier to judge when it's **butting up against the rest of the app**: real header, real sidebar, real data, real density. A throwaway route on its own is a vacuum: every variant looks fine in isolation. Default to sub-shape A whenever there's a plausible existing page to host the variants. Only reach for sub-shape B if the prototype genuinely has no nearby home.
|
||||||
|
|
||||||
### Sub-shape A — adjustment to an existing page (preferred)
|
### Sub-shape A: adjustment to an existing page (preferred)
|
||||||
|
|
||||||
The route already exists. Variants are rendered **on the same route**, gated by a `?variant=` URL search param. The existing data fetching, params, and auth all stay — only the rendering swaps. This is the default; pick it unless there's a specific reason not to.
|
The route already exists. Variants are rendered **on the same route**, gated by a `?variant=` URL search param. The existing data fetching, params, and auth all stay. Only the rendering swaps. This is the default; pick it unless there's a specific reason not to.
|
||||||
|
|
||||||
If the prototype is for something that doesn't yet have a page but *would naturally live inside one* (a new section of the dashboard, a new card on the settings screen, a new step in an existing flow) — that's still sub-shape A. Mount the variants inside the host page.
|
If the prototype is for something that doesn't yet have a page but *would naturally live inside one* (a new section of the dashboard, a new card on the settings screen, a new step in an existing flow), it's still sub-shape A. Mount the variants inside the host page.
|
||||||
|
|
||||||
### Sub-shape B — a new page (last resort)
|
### Sub-shape B: a new page (last resort)
|
||||||
|
|
||||||
Only use this when the thing being prototyped genuinely has no existing page to live inside — e.g. an entirely new top-level surface, or a flow that can't be embedded anywhere sensible.
|
Only use this when the thing being prototyped genuinely has no existing page to live inside (e.g. an entirely new top-level surface, or a flow that can't be embedded anywhere sensible).
|
||||||
|
|
||||||
Create a **throwaway route** following whatever routing convention the project already uses — don't invent a new top-level structure. Name it so it's obviously a prototype (e.g. include the word `prototype` in the path or filename). Same `?variant=` pattern.
|
Create a **throwaway route** following whatever routing convention the project already uses. Don't invent a new top-level structure. Name it so it's obviously a prototype (e.g. include the word `prototype` in the path or filename). Same `?variant=` pattern.
|
||||||
|
|
||||||
Before committing to sub-shape B, sanity-check: is there really no existing page this could be embedded in? An empty route hides design problems that a populated one would expose.
|
Before committing to sub-shape B, sanity-check: is there really no existing page this could be embedded in? An empty route hides design problems that a populated one would expose.
|
||||||
|
|
||||||
@@ -35,7 +35,7 @@ In both sub-shapes the floating bottom bar is identical.
|
|||||||
|
|
||||||
### 1. State the question and pick N
|
### 1. State the question and pick N
|
||||||
|
|
||||||
Default to **3 variants**. More than 5 stops being radically different and starts being noise — cap there.
|
Default to **3 variants**. More than 5 stops being radically different and starts being noise, so cap there.
|
||||||
|
|
||||||
Write down the plan in one line, in the prototype's location or a top-of-file comment:
|
Write down the plan in one line, in the prototype's location or a top-of-file comment:
|
||||||
|
|
||||||
@@ -51,14 +51,14 @@ Draft each variant. Hold each one to:
|
|||||||
- The project's component library / styling system (TailwindCSS, shadcn, MUI, plain CSS, whatever).
|
- The project's component library / styling system (TailwindCSS, shadcn, MUI, plain CSS, whatever).
|
||||||
- A clear exported component name, e.g. `VariantA`, `VariantB`, `VariantC`.
|
- A clear exported component name, e.g. `VariantA`, `VariantB`, `VariantC`.
|
||||||
|
|
||||||
Variants must be **structurally different** — different layout, different information hierarchy, different primary affordance, not just different colours. Three slightly-tweaked card grids isn't a UI prototype, it's wallpaper. If two drafts come out too similar, redo one with explicit "do not use a card grid" guidance.
|
Variants must be **structurally different**: different layout, different information hierarchy, different primary affordance, not just different colours. Three slightly-tweaked card grids isn't a UI prototype, it's wallpaper. If two drafts come out too similar, redo one with explicit "do not use a card grid" guidance.
|
||||||
|
|
||||||
### 3. Wire them together
|
### 3. Wire them together
|
||||||
|
|
||||||
Create a single switcher component on the route:
|
Create a single switcher component on the route:
|
||||||
|
|
||||||
```tsx
|
```tsx
|
||||||
// pseudo-code — adapt to the project's framework
|
// pseudo-code, adapt to the project's framework
|
||||||
const variant = searchParams.get('variant') ?? 'A';
|
const variant = searchParams.get('variant') ?? 'A';
|
||||||
return (
|
return (
|
||||||
<>
|
<>
|
||||||
@@ -78,35 +78,35 @@ For sub-shape B (new page): the throwaway route under `/prototype/<name>` mounts
|
|||||||
|
|
||||||
A small fixed-position bar at the bottom-centre of the screen with three pieces:
|
A small fixed-position bar at the bottom-centre of the screen with three pieces:
|
||||||
|
|
||||||
- **Left arrow** — cycles to the previous variant (wraps around).
|
- **Left arrow**: cycles to the previous variant (wraps around).
|
||||||
- **Variant label** — shows the current variant key and, if the variant exports a name, that name too. e.g. `B — Sidebar layout`.
|
- **Variant label**: shows the current variant key and, if the variant exports a name, that name too. e.g. `B (Sidebar layout)`.
|
||||||
- **Right arrow** — cycles forward (wraps around).
|
- **Right arrow**: cycles forward (wraps around).
|
||||||
|
|
||||||
Behaviour:
|
Behaviour:
|
||||||
|
|
||||||
- Clicking an arrow updates the URL search param (use the framework's router — `router.replace` on Next, `navigate` on React Router, etc) so the variant is shareable and reload-stable.
|
- Clicking an arrow updates the URL search param (use the framework's router, e.g. `router.replace` on Next, `navigate` on React Router, etc) so the variant is shareable and reload-stable.
|
||||||
- Keyboard: `←` and `→` arrow keys also cycle. Don't intercept arrow keys when an `<input>`, `<textarea>`, or `[contenteditable]` is focused.
|
- Keyboard: `←` and `→` arrow keys also cycle. Don't intercept arrow keys when an `<input>`, `<textarea>`, or `[contenteditable]` is focused.
|
||||||
- Visually distinct from the page (e.g. high-contrast pill, subtle shadow) so it's obviously not part of the design being evaluated.
|
- Visually distinct from the page (e.g. high-contrast pill, subtle shadow) so it's obviously not part of the design being evaluated.
|
||||||
- Hidden in production builds — gate on `process.env.NODE_ENV !== 'production'` or an equivalent check, so a stray prototype merge can't ship the bar to users.
|
- Hidden in production builds: gate on `process.env.NODE_ENV !== 'production'` or an equivalent check, so a stray prototype merge can't ship the bar to users.
|
||||||
|
|
||||||
Put the switcher in a single shared component so both sub-shapes can reuse it. Locate it wherever shared UI lives in the project.
|
Put the switcher in a single shared component so both sub-shapes can reuse it. Locate it wherever shared UI lives in the project.
|
||||||
|
|
||||||
### 5. Hand it over
|
### 5. Hand it over
|
||||||
|
|
||||||
Surface the URL (and the `?variant=` keys). The user will flip through whenever they get to it. The interesting feedback is usually **"I want the header from B with the sidebar from C"** — that's the actual design they want.
|
Surface the URL (and the `?variant=` keys). The user will flip through whenever they get to it. The interesting feedback is usually **"I want the header from B with the sidebar from C"**, which is the actual design they want.
|
||||||
|
|
||||||
### 6. Capture the answer and clean up
|
### 6. Capture the answer and clean up
|
||||||
|
|
||||||
Once a variant has won, capture the answer — which variant and why — then capture the prototype the way the [SKILL](SKILL.md) describes. Fold the winner into the real code and move the rest onto the throwaway branch, not into main:
|
Once a variant has won, capture the answer (which variant and why), then capture the prototype the way the [SKILL](SKILL.md) describes. Fold the winner into the real code and move the rest onto the throwaway branch, not into main:
|
||||||
|
|
||||||
- **Sub-shape A** — fold the winner into the existing page; drop the losing variants and the switcher from main.
|
- **Sub-shape A**: fold the winner into the existing page; drop the losing variants and the switcher from main.
|
||||||
- **Sub-shape B** — promote the winning variant to a real route; drop the throwaway route and the switcher from main.
|
- **Sub-shape B**: promote the winning variant to a real route; drop the throwaway route and the switcher from main.
|
||||||
|
|
||||||
The full set of variants is the primary source, so it lands on the throwaway branch, not the bin — variant components and the switcher left in the main branch rot fast and confuse the next reader.
|
The full set of variants is the primary source, so it lands on the throwaway branch, not the bin, since variant components and the switcher left in the main branch rot fast and confuse the next reader.
|
||||||
|
|
||||||
## Anti-patterns
|
## Anti-patterns
|
||||||
|
|
||||||
- **Variants that differ only in colour or copy.** That's a tweak, not a prototype. Real variants disagree about structure.
|
- **Variants that differ only in colour or copy.** That's a tweak, not a prototype. Real variants disagree about structure.
|
||||||
- **Sharing too much code between variants.** A shared `<Header>` is fine; a shared `<Layout>` defeats the point. Each variant should be free to throw out the layout.
|
- **Sharing too much code between variants.** A shared `<Header>` is fine; a shared `<Layout>` defeats the point. Each variant should be free to throw out the layout.
|
||||||
- **Wiring variants to real mutations.** Read-only prototypes are fine. If a variant needs to mutate, point it at a stub — the question is "what should this look like", not "does the backend work".
|
- **Wiring variants to real mutations.** Read-only prototypes are fine. If a variant needs to mutate, point it at a stub: the question is "what should this look like", not "does the backend work".
|
||||||
- **Promoting the prototype directly to production.** The variant code was written under prototype constraints (no tests, minimal error handling). Rewrite it properly when you fold it in.
|
- **Promoting the prototype directly to production.** The variant code was written under prototype constraints (no tests, minimal error handling). Rewrite it properly when you fold it in.
|
||||||
@@ -103,7 +103,6 @@ The resolved `preloads` array contains browser module hrefs. During server rende
|
|||||||
Use `run` to start the client runtime. It scans the document for client entry markers, loads modules, and hydrates each one:
|
Use `run` to start the client runtime. It scans the document for client entry markers, loads modules, and hydrates each one:
|
||||||
|
|
||||||
```tsx
|
```tsx
|
||||||
import type { ResolveFrameOptions } from 'remix/ui'
|
|
||||||
import { run } from 'remix/ui'
|
import { run } from 'remix/ui'
|
||||||
|
|
||||||
const app = run({
|
const app = run({
|
||||||
@@ -111,31 +110,8 @@ const app = run({
|
|||||||
let mod = await import(moduleUrl)
|
let mod = await import(moduleUrl)
|
||||||
return mod[exportName]
|
return mod[exportName]
|
||||||
},
|
},
|
||||||
async resolveFrame(src, options) {
|
|
||||||
let headers = new Headers({ accept: 'text/html', 'x-remix-frame': 'true' })
|
|
||||||
if (options?.target) headers.set('x-remix-target', options.target)
|
|
||||||
let response = await fetch(src, {
|
|
||||||
body: getRequestBody(options),
|
|
||||||
headers,
|
|
||||||
method: options?.method,
|
|
||||||
signal: options?.signal,
|
|
||||||
})
|
|
||||||
return response.body ?? (await response.text())
|
|
||||||
},
|
|
||||||
})
|
})
|
||||||
|
|
||||||
function getRequestBody(options?: ResolveFrameOptions): BodyInit | undefined {
|
|
||||||
let formData = options?.formData
|
|
||||||
if (!formData) return
|
|
||||||
if (options.encType !== 'application/x-www-form-urlencoded') return formData
|
|
||||||
|
|
||||||
let body = new URLSearchParams()
|
|
||||||
for (let [name, value] of formData) {
|
|
||||||
body.append(name, typeof value === 'string' ? value : value.name)
|
|
||||||
}
|
|
||||||
return body
|
|
||||||
}
|
|
||||||
|
|
||||||
app.addEventListener('error', (event) => {
|
app.addEventListener('error', (event) => {
|
||||||
console.error('Component error:', event.error)
|
console.error('Component error:', event.error)
|
||||||
})
|
})
|
||||||
@@ -143,10 +119,22 @@ app.addEventListener('error', (event) => {
|
|||||||
await app.ready()
|
await app.ready()
|
||||||
```
|
```
|
||||||
|
|
||||||
|
By default, `run()` resolves frames with `fetch()`, requests `text/html`, and forwards the submitted
|
||||||
|
method and abort signal. GET form values are already encoded in `src`; non-GET submissions use
|
||||||
|
`URLSearchParams` for `application/x-www-form-urlencoded`, CRLF-delimited text for `text/plain`, and
|
||||||
|
`FormData` for `multipart/form-data`. Provide `resolveFrame` when an app needs additional headers,
|
||||||
|
another body encoding, or a different response policy.
|
||||||
|
|
||||||
|
Add `rmx-document` to a link or form to leave its navigation to the browser.
|
||||||
|
|
||||||
|
The default resolver rejects non-OK responses with an error containing their status and status text.
|
||||||
|
A custom `resolveFrame` may return a `Response` with any status when it wants the runtime to render
|
||||||
|
the response body.
|
||||||
|
|
||||||
### `run` options
|
### `run` options
|
||||||
|
|
||||||
- **`loadModule(moduleUrl, exportName)`** (required) — return the component function for each client entry. Typically uses dynamic `import()`.
|
- **`loadModule(moduleUrl, exportName)`** (required) — return the component function for each client entry. Typically uses dynamic `import()`.
|
||||||
- **`resolveFrame(src, options)`** (optional) — called when a `<Frame>` loads or reloads content and for intercepted link and form navigations. `options` may contain `signal` and `target`; non-GET forms also provide `formData`, `method`, and `encType`.
|
- **`resolveFrame(src, options)`** (optional) — overrides the default `fetch()` resolver when a `<Frame>` loads or reloads content and for intercepted link and form navigations. `options` may contain `signal` and `target`; non-GET forms also provide `formData`, `method`, and `encType`.
|
||||||
|
|
||||||
### `app` methods
|
### `app` methods
|
||||||
|
|
||||||
@@ -217,7 +205,7 @@ When a frame reloads, matching DOM nodes are updated in place. Client entries re
|
|||||||
|
|
||||||
### Form navigation
|
### Form navigation
|
||||||
|
|
||||||
When `run({ resolveFrame })` is active, eligible same-origin forms progressively enhance into frame navigations. Native validation and the form's `submit` event still run first.
|
When `run()` is active, eligible same-origin forms progressively enhance into frame navigations. Native validation and the form's `submit` event still run first.
|
||||||
|
|
||||||
- Forms target `handle.frames.top` by default.
|
- Forms target `handle.frames.top` by default.
|
||||||
- `rmx-target` selects a named frame.
|
- `rmx-target` selects a named frame.
|
||||||
|
|||||||
@@ -9,6 +9,6 @@ description: "Use when you need to resolve an in-progress git merge/rebase confl
|
|||||||
|
|
||||||
3. **Resolve each hunk.** Preserve both intents where possible. Where incompatible, pick the one matching the merge's stated goal and note the trade-off. Do **not** invent new behaviour. Always resolve; never `--abort`.
|
3. **Resolve each hunk.** Preserve both intents where possible. Where incompatible, pick the one matching the merge's stated goal and note the trade-off. Do **not** invent new behaviour. Always resolve; never `--abort`.
|
||||||
|
|
||||||
4. Discover the project's **automated checks** and run them — typically typecheck, then tests, then format. Fix anything the merge broke.
|
4. Discover the project's **automated checks** and run them, typically typecheck, then tests, then format. Fix anything the merge broke.
|
||||||
|
|
||||||
5. **Finish the merge/rebase.** Stage everything and commit. If rebasing, continue the rebase process until all commits are rebased.
|
5. **Finish the merge/rebase.** Stage everything and commit. If rebasing, continue the rebase process until all commits are rebased.
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
name: setup-matt-pocock-skills
|
name: setup-matt-pocock-skills
|
||||||
description: Configure this repo for the engineering skills — set up its issue tracker, triage label vocabulary, and domain doc layout. Run once before first use of the other engineering skills.
|
description: "Configure this repo for the engineering skills: set up its issue tracker, triage label vocabulary, and domain doc layout. Run once before first use of the other engineering skills."
|
||||||
disable-model-invocation: true
|
disable-model-invocation: true
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -8,9 +8,9 @@ disable-model-invocation: true
|
|||||||
|
|
||||||
Scaffold the per-repo configuration that the engineering skills assume:
|
Scaffold the per-repo configuration that the engineering skills assume:
|
||||||
|
|
||||||
- **Issue tracker** — where issues live (GitHub by default; local markdown is also supported out of the box)
|
- **Issue tracker**: where issues live (GitHub by default; local markdown is also supported out of the box)
|
||||||
- **Triage labels** — the strings used for the five canonical triage roles
|
- **Triage labels**: the strings used for the five canonical triage roles
|
||||||
- **Domain docs** — where `CONTEXT.md` and ADRs live, and the consumer rules for reading them
|
- **Domain docs**: where `CONTEXT.md` and ADRs live, and the consumer rules for reading them
|
||||||
|
|
||||||
This is a prompt-driven skill, not a deterministic script. Explore, present what you found, confirm with the user, then write.
|
This is a prompt-driven skill, not a deterministic script. Explore, present what you found, confirm with the user, then write.
|
||||||
|
|
||||||
@@ -20,45 +20,45 @@ This is a prompt-driven skill, not a deterministic script. Explore, present what
|
|||||||
|
|
||||||
Look at the current repo to understand its starting state. Read whatever exists; don't assume:
|
Look at the current repo to understand its starting state. Read whatever exists; don't assume:
|
||||||
|
|
||||||
- `git remote -v` and `.git/config` — is this a GitHub repo? Which one?
|
- `git remote -v` and `.git/config`: is this a GitHub repo? Which one?
|
||||||
- `AGENTS.md` and `CLAUDE.md` at the repo root — does either exist? Is there already an `## Agent skills` section in either?
|
- `AGENTS.md` and `CLAUDE.md` at the repo root: does either exist? Is there already an `## Agent skills` section in either?
|
||||||
- `CONTEXT.md` and `CONTEXT-MAP.md` at the repo root
|
- `CONTEXT.md` and `CONTEXT-MAP.md` at the repo root
|
||||||
- `docs/adr/` and any `src/*/docs/adr/` directories
|
- `docs/adr/` and any `src/*/docs/adr/` directories
|
||||||
- `docs/agents/` — does this skill's prior output already exist?
|
- `docs/agents/`: does this skill's prior output already exist?
|
||||||
- `.scratch/` — sign that a local-markdown issue tracker convention is already in use
|
- `.scratch/`: a sign that a local-markdown issue tracker convention is already in use
|
||||||
- Is the `triage` skill installed? (a `triage` skill folder alongside this one, or `triage` in your available skills.) This decides whether Section B runs at all.
|
- Is the `triage` skill installed? (a `triage` skill folder alongside this one, or `triage` in your available skills.) This decides whether Section B runs at all.
|
||||||
- Monorepo signals — a `pnpm-workspace.yaml`, a `workspaces` field in `package.json`, or a populated `packages/*` with its own `src/`. Present only in a genuinely large multi-package repo; their absence means single-context, which is almost every repo.
|
- Monorepo signals: a `pnpm-workspace.yaml`, a `workspaces` field in `package.json`, or a populated `packages/*` with its own `src/`. These are present only in a genuinely large multi-package repo; their absence means single-context, which is almost every repo.
|
||||||
|
|
||||||
### 2. Present findings and ask
|
### 2. Present findings and ask
|
||||||
|
|
||||||
Summarise what's present and what's missing. Then take the sections in order — one section, one answer, then the next.
|
Summarise what's present and what's missing. Then take the sections in order. One section, one answer, then the next.
|
||||||
|
|
||||||
Lead each section with the recommended answer so the user can accept it in a word. Give a one-line explainer only when the choice genuinely branches; skip the section entirely when exploration already settled it (Section B when `triage` isn't installed, Section C when there's no monorepo).
|
Lead each section with the recommended answer so the user can accept it in a word. Give a one-line explainer only when the choice genuinely branches; skip the section entirely when exploration already settled it (Section B when `triage` isn't installed, Section C when there's no monorepo).
|
||||||
|
|
||||||
**Section A — Issue tracker.**
|
**Section A: Issue tracker.**
|
||||||
|
|
||||||
> Explainer: The "issue tracker" is where issues live for this repo. Skills like `to-tickets`, `triage`, and `to-spec` read from and write to it — they need to know whether to call `gh issue create`, write a markdown file under `.scratch/`, or follow some other workflow you describe. Pick the place you actually track work for this repo.
|
> Explainer: The "issue tracker" is where issues live for this repo. Skills like `to-tickets`, `triage`, and `to-spec` read from and write to it. They need to know whether to call `gh issue create`, write a markdown file under `.scratch/`, or follow some other workflow you describe. Pick the place you actually track work for this repo.
|
||||||
|
|
||||||
Default posture: these skills were designed for GitHub. If a `git remote` points at GitHub, propose that. If a `git remote` points at GitLab (`gitlab.com` or a self-hosted host), propose GitLab. Otherwise (or if the user prefers), offer:
|
Default posture: these skills were designed for GitHub. If a `git remote` points at GitHub, propose that. If a `git remote` points at GitLab (`gitlab.com` or a self-hosted host), propose GitLab. Otherwise (or if the user prefers), offer:
|
||||||
|
|
||||||
- **GitHub** — issues live in the repo's GitHub Issues (uses the `gh` CLI)
|
- **GitHub**: issues live in the repo's GitHub Issues (uses the `gh` CLI)
|
||||||
- **GitLab** — issues live in the repo's GitLab Issues (uses the [`glab`](https://gitlab.com/gitlab-org/cli) CLI)
|
- **GitLab**: issues live in the repo's GitLab Issues (uses the [`glab`](https://gitlab.com/gitlab-org/cli) CLI)
|
||||||
- **Local markdown** — issues live as files under `.scratch/<feature>/` in this repo (good for solo projects or repos without a remote)
|
- **Local markdown**: issues live as files under `.scratch/<feature>/` in this repo (good for solo projects or repos without a remote)
|
||||||
- **Other** (Jira, Linear, etc.) — ask the user to describe the workflow in one paragraph; the skill will record it as freeform prose
|
- **Other** (Jira, Linear, etc.): ask the user to describe the workflow in one paragraph; the skill will record it as freeform prose
|
||||||
|
|
||||||
Record the choice in `docs/agents/issue-tracker.md`. The GitHub and GitLab templates carry a "PRs as a request surface" flag, defaulted **off** — leave it off and don't raise it; a user who wants external PRs in the triage queue can flip the flag in the file later.
|
Record the choice in `docs/agents/issue-tracker.md`. The GitHub and GitLab templates carry a "PRs as a request surface" flag, defaulted **off**. Leave it off and don't raise it: a user who wants external PRs in the triage queue can flip the flag in the file later.
|
||||||
|
|
||||||
**Section B — Triage label vocabulary.** Skip this section entirely if the `triage` skill isn't installed (exploration told you) — an uninstalled skill needs no labels.
|
**Section B: Triage label vocabulary.** Skip this section entirely if the `triage` skill isn't installed (exploration told you), since an uninstalled skill needs no labels.
|
||||||
|
|
||||||
If it is installed, ask exactly one question:
|
If it is installed, ask exactly one question:
|
||||||
|
|
||||||
> Do you want to keep the default triage labels? (recommended: **yes**)
|
> Do you want to keep the default triage labels? (recommended: **yes**)
|
||||||
|
|
||||||
The defaults are the five canonical roles, each label string equal to its name: `needs-triage`, `needs-info`, `ready-for-agent`, `ready-for-human`, `wontfix`. On **yes**, write them as-is. Only if the user says no — usually because their tracker already uses other names (e.g. `bug:triage` for `needs-triage`) — collect the overrides so `triage` applies existing labels instead of creating duplicates.
|
The defaults are the five canonical roles, each label string equal to its name: `needs-triage`, `needs-info`, `ready-for-agent`, `ready-for-human`, `wontfix`. On **yes**, write them as-is. Only if the user says no, usually because their tracker already uses other names (e.g. `bug:triage` for `needs-triage`), collect the overrides so `triage` applies existing labels instead of creating duplicates.
|
||||||
|
|
||||||
**Section C — Domain docs.** Default to **single-context** — one `CONTEXT.md` + `docs/adr/` at the repo root. This fits almost every repo; write it without asking.
|
**Section C: Domain docs.** Default to **single-context** (one `CONTEXT.md` + `docs/adr/` at the repo root). This fits almost every repo; write it without asking.
|
||||||
|
|
||||||
Offer **multi-context** — a root `CONTEXT-MAP.md` pointing to per-context `CONTEXT.md` files — only when exploration found monorepo signals. Then confirm which layout they want.
|
Offer **multi-context** (a root `CONTEXT-MAP.md` pointing to per-context `CONTEXT.md` files) only when exploration found monorepo signals. Then confirm which layout they want.
|
||||||
|
|
||||||
### 3. Confirm and edit
|
### 3. Confirm and edit
|
||||||
|
|
||||||
@@ -75,9 +75,9 @@ Let them edit before writing.
|
|||||||
|
|
||||||
- If `CLAUDE.md` exists, edit it.
|
- If `CLAUDE.md` exists, edit it.
|
||||||
- Else if `AGENTS.md` exists, edit it.
|
- Else if `AGENTS.md` exists, edit it.
|
||||||
- If neither exists, ask the user which one to create — don't pick for them.
|
- If neither exists, ask the user which one to create; don't pick for them.
|
||||||
|
|
||||||
Never create `AGENTS.md` when `CLAUDE.md` already exists (or vice versa) — always edit the one that's already there.
|
Never create `AGENTS.md` when `CLAUDE.md` already exists (or vice versa); always edit the one that's already there.
|
||||||
|
|
||||||
If an `## Agent skills` block already exists in the chosen file, update its contents in-place rather than appending a duplicate. Don't overwrite user edits to the surrounding sections.
|
If an `## Agent skills` block already exists in the chosen file, update its contents in-place rather than appending a duplicate. Don't overwrite user edits to the surrounding sections.
|
||||||
|
|
||||||
@@ -96,21 +96,21 @@ The block:
|
|||||||
|
|
||||||
### Domain docs
|
### Domain docs
|
||||||
|
|
||||||
[one-line summary of layout — "single-context" or "multi-context"]. See `docs/agents/domain.md`.
|
[one-line summary of layout: "single-context" or "multi-context"]. See `docs/agents/domain.md`.
|
||||||
```
|
```
|
||||||
|
|
||||||
Include the `### Triage labels` sub-block, and write `docs/agents/triage-labels.md`, only when `triage` is installed and Section B ran. When it isn't, both are omitted.
|
Include the `### Triage labels` sub-block, and write `docs/agents/triage-labels.md`, only when `triage` is installed and Section B ran. When it isn't, both are omitted.
|
||||||
|
|
||||||
Then write the docs files using the seed templates in this skill folder as a starting point:
|
Then write the docs files using the seed templates in this skill folder as a starting point:
|
||||||
|
|
||||||
- [issue-tracker-github.md](./issue-tracker-github.md) — GitHub issue tracker
|
- [issue-tracker-github.md](./issue-tracker-github.md): GitHub issue tracker
|
||||||
- [issue-tracker-gitlab.md](./issue-tracker-gitlab.md) — GitLab issue tracker
|
- [issue-tracker-gitlab.md](./issue-tracker-gitlab.md): GitLab issue tracker
|
||||||
- [issue-tracker-local.md](./issue-tracker-local.md) — local-markdown issue tracker
|
- [issue-tracker-local.md](./issue-tracker-local.md): local-markdown issue tracker
|
||||||
- [triage-labels.md](./triage-labels.md) — label mapping (only if `triage` is installed)
|
- [triage-labels.md](./triage-labels.md): label mapping (only if `triage` is installed)
|
||||||
- [domain.md](./domain.md) — domain doc consumer rules + layout
|
- [domain.md](./domain.md): domain doc consumer rules + layout
|
||||||
|
|
||||||
For "other" issue trackers, write `docs/agents/issue-tracker.md` from scratch using the user's description.
|
For "other" issue trackers, write `docs/agents/issue-tracker.md` from scratch using the user's description.
|
||||||
|
|
||||||
### 5. Done
|
### 5. Done
|
||||||
|
|
||||||
Tell the user the setup is complete and which engineering skills will now read from these files. Mention they can edit `docs/agents/*.md` directly later — re-running this skill is only necessary if they want to switch issue trackers or restart from scratch.
|
Tell the user the setup is complete and which engineering skills will now read from these files. Mention they can edit `docs/agents/*.md` directly later; re-running this skill is only necessary if they want to switch issue trackers or restart from scratch.
|
||||||
@@ -5,8 +5,8 @@ How the engineering skills should consume this repo's domain documentation when
|
|||||||
## Before exploring, read these
|
## Before exploring, read these
|
||||||
|
|
||||||
- **`CONTEXT.md`** at the repo root, or
|
- **`CONTEXT.md`** at the repo root, or
|
||||||
- **`CONTEXT-MAP.md`** at the repo root if it exists — it points at one `CONTEXT.md` per context. Read each one relevant to the topic.
|
- **`CONTEXT-MAP.md`** at the repo root if it exists: it points at one `CONTEXT.md` per context. Read each one relevant to the topic.
|
||||||
- **`docs/adr/`** — read ADRs that touch the area you're about to work in. In multi-context repos, also check `src/<context>/docs/adr/` for context-scoped decisions.
|
- **`docs/adr/`**: read ADRs that touch the area you're about to work in. In multi-context repos, also check `src/<context>/docs/adr/` for context-scoped decisions.
|
||||||
|
|
||||||
If any of these files don't exist, **proceed silently**. Don't flag their absence; don't suggest creating them upfront. The `/domain-modeling` skill (reached via `/grill-with-docs` and `/improve-codebase-architecture`) creates them lazily when terms or decisions actually get resolved.
|
If any of these files don't exist, **proceed silently**. Don't flag their absence; don't suggest creating them upfront. The `/domain-modeling` skill (reached via `/grill-with-docs` and `/improve-codebase-architecture`) creates them lazily when terms or decisions actually get resolved.
|
||||||
|
|
||||||
@@ -42,10 +42,10 @@ Multi-context repo (presence of `CONTEXT-MAP.md` at the root):
|
|||||||
|
|
||||||
When your output names a domain concept (in an issue title, a refactor proposal, a hypothesis, a test name), use the term as defined in `CONTEXT.md`. Don't drift to synonyms the glossary explicitly avoids.
|
When your output names a domain concept (in an issue title, a refactor proposal, a hypothesis, a test name), use the term as defined in `CONTEXT.md`. Don't drift to synonyms the glossary explicitly avoids.
|
||||||
|
|
||||||
If the concept you need isn't in the glossary yet, that's a signal — either you're inventing language the project doesn't use (reconsider) or there's a real gap (note it for `/domain-modeling`).
|
If the concept you need isn't in the glossary yet, that's a signal: either you're inventing language the project doesn't use (reconsider) or there's a real gap (note it for `/domain-modeling`).
|
||||||
|
|
||||||
## Flag ADR conflicts
|
## Flag ADR conflicts
|
||||||
|
|
||||||
If your output contradicts an existing ADR, surface it explicitly rather than silently overriding:
|
If your output contradicts an existing ADR, surface it explicitly rather than silently overriding:
|
||||||
|
|
||||||
> _Contradicts ADR-0007 (event-sourced orders) — but worth reopening because…_
|
> _Contradicts ADR-0007 (event-sourced orders), but worth reopening because…_
|
||||||
@@ -11,7 +11,7 @@ Issues and specs for this repo live as GitHub issues. Use the `gh` CLI for all o
|
|||||||
- **Apply / remove labels**: `gh issue edit <number> --add-label "..."` / `--remove-label "..."`
|
- **Apply / remove labels**: `gh issue edit <number> --add-label "..."` / `--remove-label "..."`
|
||||||
- **Close**: `gh issue close <number> --comment "..."`
|
- **Close**: `gh issue close <number> --comment "..."`
|
||||||
|
|
||||||
Infer the repo from `git remote -v` — `gh` does this automatically when run inside a clone.
|
Infer the repo from `git remote -v`; `gh` does this automatically when run inside a clone.
|
||||||
|
|
||||||
## Pull requests as a triage surface
|
## Pull requests as a triage surface
|
||||||
|
|
||||||
@@ -23,7 +23,7 @@ When set to `yes`, PRs run through the same labels and states as issues, using t
|
|||||||
- **List external PRs for triage**: `gh pr list --state open --json number,title,body,labels,author,authorAssociation,comments` then keep only `authorAssociation` of `CONTRIBUTOR`, `FIRST_TIME_CONTRIBUTOR`, or `NONE` (drop `OWNER`/`MEMBER`/`COLLABORATOR`).
|
- **List external PRs for triage**: `gh pr list --state open --json number,title,body,labels,author,authorAssociation,comments` then keep only `authorAssociation` of `CONTRIBUTOR`, `FIRST_TIME_CONTRIBUTOR`, or `NONE` (drop `OWNER`/`MEMBER`/`COLLABORATOR`).
|
||||||
- **Comment / label / close**: `gh pr comment`, `gh pr edit --add-label`/`--remove-label`, `gh pr close`.
|
- **Comment / label / close**: `gh pr comment`, `gh pr edit --add-label`/`--remove-label`, `gh pr close`.
|
||||||
|
|
||||||
GitHub shares one number space across issues and PRs, so a bare `#42` may be either — resolve with `gh pr view 42` and fall back to `gh issue view 42`.
|
GitHub shares one number space across issues and PRs, so a bare `#42` may be either: resolve with `gh pr view 42` and fall back to `gh issue view 42`.
|
||||||
|
|
||||||
## When a skill says "publish to the issue tracker"
|
## When a skill says "publish to the issue tracker"
|
||||||
|
|
||||||
@@ -39,7 +39,7 @@ Used by `/wayfinder`. The **map** is a single issue with **child** issues as tic
|
|||||||
|
|
||||||
- **Map**: a single issue labelled `wayfinder:map`, holding the Notes / Decisions-so-far / Fog body. `gh issue create --label wayfinder:map`.
|
- **Map**: a single issue labelled `wayfinder:map`, holding the Notes / Decisions-so-far / Fog body. `gh issue create --label wayfinder:map`.
|
||||||
- **Child ticket**: an issue linked to the map as a GitHub sub-issue (`gh api` on the sub-issues endpoint). Where sub-issues aren't enabled, add the child to a task list in the map body and put `Part of #<map>` at the top of the child body. Labels: `wayfinder:<type>` (`research`/`prototype`/`grilling`/`task`). Once claimed, the ticket is assigned to the driving dev.
|
- **Child ticket**: an issue linked to the map as a GitHub sub-issue (`gh api` on the sub-issues endpoint). Where sub-issues aren't enabled, add the child to a task list in the map body and put `Part of #<map>` at the top of the child body. Labels: `wayfinder:<type>` (`research`/`prototype`/`grilling`/`task`). Once claimed, the ticket is assigned to the driving dev.
|
||||||
- **Blocking**: GitHub's **native issue dependencies** — the canonical, UI-visible representation. Add an edge with `gh api --method POST repos/<owner>/<repo>/issues/<child>/dependencies/blocked_by -F issue_id=<blocker-db-id>`, where `<blocker-db-id>` is the blocker's numeric **database id** (`gh api repos/<owner>/<repo>/issues/<n> --jq .id`, _not_ the `#number` or `node_id`). GitHub reports `issue_dependencies_summary.blocked_by` (open blockers only — the live gate). Where dependencies aren't available, fall back to a `Blocked by: #<n>, #<n>` line at the top of the child body. A ticket is unblocked when every blocker is closed.
|
- **Blocking**: GitHub's **native issue dependencies**, the canonical, UI-visible representation. Add an edge with `gh api --method POST repos/<owner>/<repo>/issues/<child>/dependencies/blocked_by -F issue_id=<blocker-db-id>`, where `<blocker-db-id>` is the blocker's numeric **database id** (`gh api repos/<owner>/<repo>/issues/<n> --jq .id`, _not_ the `#number` or `node_id`). GitHub reports `issue_dependencies_summary.blocked_by` (open blockers only, the live gate). Where dependencies aren't available, fall back to a `Blocked by: #<n>, #<n>` line at the top of the child body. A ticket is unblocked when every blocker is closed.
|
||||||
- **Frontier query**: list the map's open children (`gh issue list --state open`, scoped to the map's sub-issues / task list), drop any with an open blocker (`issue_dependencies_summary.blocked_by > 0`, or an open issue in the `Blocked by` line) or an assignee; first in map order wins.
|
- **Frontier query**: list the map's open children (`gh issue list --state open`, scoped to the map's sub-issues / task list), drop any with an open blocker (`issue_dependencies_summary.blocked_by > 0`, or an open issue in the `Blocked by` line) or an assignee; first in map order wins.
|
||||||
- **Claim**: `gh issue edit <n> --add-assignee @me` — the session's first write.
|
- **Claim**: `gh issue edit <n> --add-assignee @me`, the session's first write.
|
||||||
- **Resolve**: `gh issue comment <n> --body "<answer>"`, then `gh issue close <n>`, then append a context pointer (gist + link) to the map's Decisions-so-far.
|
- **Resolve**: `gh issue comment <n> --body "<answer>"`, then `gh issue close <n>`, then append a context pointer (gist + link) to the map's Decisions-so-far.
|
||||||
@@ -10,9 +10,9 @@ Issues and specs for this repo live as GitLab issues. Use the [`glab`](https://g
|
|||||||
- **Comment on an issue**: `glab issue note <number> --message "..."`. GitLab calls comments "notes".
|
- **Comment on an issue**: `glab issue note <number> --message "..."`. GitLab calls comments "notes".
|
||||||
- **Apply / remove labels**: `glab issue update <number> --label "..."` / `--unlabel "..."`. Multiple labels can be comma-separated or by repeating the flag.
|
- **Apply / remove labels**: `glab issue update <number> --label "..."` / `--unlabel "..."`. Multiple labels can be comma-separated or by repeating the flag.
|
||||||
- **Close**: `glab issue close <number>`. `glab issue close` does not accept a closing comment, so post the explanation first with `glab issue note <number> --message "..."`, then close.
|
- **Close**: `glab issue close <number>`. `glab issue close` does not accept a closing comment, so post the explanation first with `glab issue note <number> --message "..."`, then close.
|
||||||
- **Merge requests**: GitLab calls PRs "merge requests". Use `glab mr create`, `glab mr view`, `glab mr note`, etc. — the same shape as `gh pr ...` with `mr` in place of `pr` and `note`/`--message` in place of `comment`/`--body`.
|
- **Merge requests**: GitLab calls PRs "merge requests". Use `glab mr create`, `glab mr view`, `glab mr note`, etc., the same shape as `gh pr ...` with `mr` in place of `pr` and `note`/`--message` in place of `comment`/`--body`.
|
||||||
|
|
||||||
Infer the repo from `git remote -v` — `glab` does this automatically when run inside a clone.
|
Infer the repo from `git remote -v`; `glab` does this automatically when run inside a clone.
|
||||||
|
|
||||||
## Merge requests as a triage surface
|
## Merge requests as a triage surface
|
||||||
|
|
||||||
@@ -40,7 +40,7 @@ Used by `/wayfinder`. The **map** is a single issue with **child** issues as tic
|
|||||||
|
|
||||||
- **Map**: a single issue labelled `wayfinder:map`, holding the Notes / Decisions-so-far / Fog body. `glab issue create --label wayfinder:map`. (On GitLab tiers with native epics, an epic may hold the map instead; a labelled issue works everywhere.)
|
- **Map**: a single issue labelled `wayfinder:map`, holding the Notes / Decisions-so-far / Fog body. `glab issue create --label wayfinder:map`. (On GitLab tiers with native epics, an epic may hold the map instead; a labelled issue works everywhere.)
|
||||||
- **Child ticket**: an issue carrying `Part of #<map>` at the top of its description and labels `wayfinder:<type>` (`research`/`prototype`/`grilling`/`task`). Once claimed, the ticket is assigned to the driving dev.
|
- **Child ticket**: an issue carrying `Part of #<map>` at the top of its description and labels `wayfinder:<type>` (`research`/`prototype`/`grilling`/`task`). Once claimed, the ticket is assigned to the driving dev.
|
||||||
- **Blocking**: GitLab's **native blocking link** — the canonical, UI-visible representation. Add it with the `/blocked_by #<n>` quick action, posted as a note (`glab issue note <child> --message "/blocked_by #<blocker>"`). Native blocking links are a Premium/Ultimate feature; on the free tier (or where unavailable) fall back to a `Blocked by: #<n>, #<n>` line at the top of the description. A ticket is unblocked when every blocker is closed.
|
- **Blocking**: GitLab's **native blocking link**, the canonical, UI-visible representation. Add it with the `/blocked_by #<n>` quick action, posted as a note (`glab issue note <child> --message "/blocked_by #<blocker>"`). Native blocking links are a Premium/Ultimate feature; on the free tier (or where unavailable) fall back to a `Blocked by: #<n>, #<n>` line at the top of the description. A ticket is unblocked when every blocker is closed.
|
||||||
- **Frontier query**: `glab issue list -F json` scoped to the map's children, drop any with an open blocker — a native `blocked_by` link to an open issue (`glab api projects/:id/issues/:iid/links`), or an open issue in the `Blocked by` line — or an assignee; first in map order wins.
|
- **Frontier query**: `glab issue list -F json` scoped to the map's children, drop any with an open blocker: a native `blocked_by` link to an open issue (`glab api projects/:id/issues/:iid/links`), or an open issue in the `Blocked by` line, or an assignee; first in map order wins.
|
||||||
- **Claim**: `glab issue update <n> --assignee @me` — the session's first write.
|
- **Claim**: `glab issue update <n> --assignee @me`, the session's first write.
|
||||||
- **Resolve**: `glab issue note <n> --message "<answer>"`, then `glab issue close <n>`, then append a context pointer (gist + link) to the map's Decisions-so-far.
|
- **Resolve**: `glab issue note <n> --message "<answer>"`, then `glab issue close <n>`, then append a context pointer (gist + link) to the map's Decisions-so-far.
|
||||||
@@ -6,7 +6,7 @@ Issues and specs for this repo live as markdown files in `.scratch/`.
|
|||||||
|
|
||||||
- One feature per directory: `.scratch/<feature-slug>/`
|
- One feature per directory: `.scratch/<feature-slug>/`
|
||||||
- The spec is `.scratch/<feature-slug>/spec.md`
|
- The spec is `.scratch/<feature-slug>/spec.md`
|
||||||
- Implementation issues are one file per ticket at `.scratch/<feature-slug>/issues/<NN>-<slug>.md`, numbered from `01` — never a single combined tickets file
|
- Implementation issues are one file per ticket at `.scratch/<feature-slug>/issues/<NN>-<slug>.md`, numbered from `01`, never a single combined tickets file
|
||||||
- Triage state is recorded as a `Status:` line near the top of each issue file (see `triage-labels.md` for the role strings)
|
- Triage state is recorded as a `Status:` line near the top of each issue file (see `triage-labels.md` for the role strings)
|
||||||
- Comments and conversation history append to the bottom of the file under a `## Comments` heading
|
- Comments and conversation history append to the bottom of the file under a `## Comments` heading
|
||||||
|
|
||||||
@@ -22,7 +22,7 @@ Read the file at the referenced path. The user will normally pass the path or th
|
|||||||
|
|
||||||
Used by `/wayfinder`. The **map** is a file with one **child** file per ticket.
|
Used by `/wayfinder`. The **map** is a file with one **child** file per ticket.
|
||||||
|
|
||||||
- **Map**: `.scratch/<effort>/map.md` — the Notes / Decisions-so-far / Fog body.
|
- **Map**: `.scratch/<effort>/map.md` (the Notes / Decisions-so-far / Fog body).
|
||||||
- **Child ticket**: `.scratch/<effort>/issues/NN-<slug>.md`, numbered from `01`, with the question in the body. A `Type:` line records the ticket type (`research`/`prototype`/`grilling`/`task`); a `Status:` line records `claimed`/`resolved`.
|
- **Child ticket**: `.scratch/<effort>/issues/NN-<slug>.md`, numbered from `01`, with the question in the body. A `Type:` line records the ticket type (`research`/`prototype`/`grilling`/`task`); a `Status:` line records `claimed`/`resolved`.
|
||||||
- **Blocking**: a `Blocked by: NN, NN` line near the top. A ticket is unblocked when every file it lists is `resolved`.
|
- **Blocking**: a `Blocked by: NN, NN` line near the top. A ticket is unblocked when every file it lists is `resolved`.
|
||||||
- **Frontier**: scan `.scratch/<effort>/issues/` for files that are open, unblocked, and unclaimed; first by number wins.
|
- **Frontier**: scan `.scratch/<effort>/issues/` for files that are open, unblocked, and unclaimed; first by number wins.
|
||||||
|
|||||||
@@ -82,7 +82,7 @@ Only create if no Prettier config exists. Use these defaults:
|
|||||||
|
|
||||||
Stage all changed/created files and commit with message: `Add pre-commit hooks (husky + lint-staged + prettier)`
|
Stage all changed/created files and commit with message: `Add pre-commit hooks (husky + lint-staged + prettier)`
|
||||||
|
|
||||||
This will run through the new pre-commit hooks — a good smoke test that everything works.
|
This will run through the new pre-commit hooks: a good smoke test that everything works.
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
|
|||||||
@@ -5,31 +5,31 @@ description: Test-driven development. Use when the user wants to build features
|
|||||||
|
|
||||||
# Test-Driven Development
|
# Test-Driven Development
|
||||||
|
|
||||||
TDD is the red → green loop. This skill is the reference that makes that loop produce tests worth keeping: what a good test is, where tests go, the anti-patterns, and the rules of the loop. Every section applies on every cycle — consult them before and during the loop, not after.
|
TDD is the red → green loop. This skill is the reference that makes that loop produce tests worth keeping: what a good test is, where tests go, the anti-patterns, and the rules of the loop. Every section applies on every cycle: consult them before and during the loop, not after.
|
||||||
|
|
||||||
When exploring the codebase, read `CONTEXT.md` (if it exists) so test names and interface vocabulary match the project's domain language, and respect ADRs in the area you're touching.
|
When exploring the codebase, read `CONTEXT.md` (if it exists) so test names and interface vocabulary match the project's domain language, and respect ADRs in the area you're touching.
|
||||||
|
|
||||||
## What a good test is
|
## What a good test is
|
||||||
|
|
||||||
Tests verify behavior through public interfaces, not implementation details. Code can change entirely; tests shouldn't. A good test reads like a specification — "user can checkout with valid cart" tells you exactly what capability exists — and survives refactors because it doesn't care about internal structure.
|
Tests verify behavior through public interfaces, not implementation details. Code can change entirely; tests shouldn't. A good test reads like a specification: "user can checkout with valid cart" tells you exactly what capability exists, and it survives refactors because it doesn't care about internal structure.
|
||||||
|
|
||||||
See [tests.md](tests.md) for examples and [mocking.md](mocking.md) for mocking guidelines.
|
See [tests.md](tests.md) for examples and [mocking.md](mocking.md) for mocking guidelines.
|
||||||
|
|
||||||
## Seams — where tests go
|
## Seams: where tests go
|
||||||
|
|
||||||
A **seam** is the public boundary you test at: the interface where you observe behavior without reaching inside. Tests live at seams, never against internals.
|
A **seam** is the public boundary you test at: the interface where you observe behavior without reaching inside. Tests live at seams, never against internals.
|
||||||
|
|
||||||
**Test only at pre-agreed seams.** Before writing any test, write down the seams under test and confirm them with the user. No test is written at an unconfirmed seam. You can't test everything — agreeing the seams up front is how testing effort lands on the critical paths and complex logic instead of every edge case.
|
**Test only at pre-agreed seams.** Before writing any test, write down the seams under test and confirm them with the user. No test is written at an unconfirmed seam. You can't test everything, so agreeing the seams up front is how testing effort lands on the critical paths and complex logic instead of every edge case.
|
||||||
|
|
||||||
Ask: "What's the public interface, and which seams should we test?"
|
Ask: "What's the public interface, and which seams should we test?"
|
||||||
|
|
||||||
When the shape of that interface is itself in question — how deep the module is, where the seam belongs, what the interface should expose — call the Skill tool with "codebase-design" for the vocabulary. It is the shared source of the module, interface, depth, seam, adapter, leverage and locality terms, and it is a reference to consult, not a session to run.
|
When the shape of that interface is itself in question (how deep the module is, where the seam belongs, what the interface should expose), call the Skill tool with "codebase-design" for the vocabulary. It is the shared source of the module, interface, depth, seam, adapter, leverage and locality terms, and it is a reference to consult, not a session to run.
|
||||||
|
|
||||||
## Anti-patterns
|
## Anti-patterns
|
||||||
|
|
||||||
- **Implementation-coupled** — mocks internal collaborators, tests private methods, or verifies through a side channel (querying the database instead of using the interface). The tell: the test breaks when you refactor but behavior hasn't changed.
|
- **Implementation-coupled**: mocks internal collaborators, tests private methods, or verifies through a side channel (querying the database instead of using the interface). The tell: the test breaks when you refactor but behavior hasn't changed.
|
||||||
- **Tautological** — the assertion recomputes the expected value the way the code does (`expect(add(a, b)).toBe(a + b)`, a snapshot derived by hand the same way, a constant asserted equal to itself), so it passes by construction and can never disagree with the code. Expected values must come from an independent source of truth — a known-good literal, a worked example, the spec.
|
- **Tautological**: the assertion recomputes the expected value the way the code does (`expect(add(a, b)).toBe(a + b)`, a snapshot derived by hand the same way, a constant asserted equal to itself), so it passes by construction and can never disagree with the code. Expected values must come from an independent source of truth: a known-good literal, a worked example, the spec.
|
||||||
- **Horizontal slicing** — writing all tests first, then all implementation. Bulk tests verify _imagined_ behavior: you test the _shape_ of things rather than user-facing behavior, the tests go insensitive to real changes, and you commit to test structure before understanding the implementation. Work in **vertical slices** instead — one test → one implementation → repeat, each test a **tracer bullet** that responds to what the last cycle taught you.
|
- **Horizontal slicing**: writing all tests first, then all implementation. Bulk tests verify _imagined_ behavior: you test the _shape_ of things rather than user-facing behavior, the tests go insensitive to real changes, and you commit to test structure before understanding the implementation. Work in **vertical slices** instead: one test → one implementation → repeat, each test a **tracer bullet** that responds to what the last cycle taught you.
|
||||||
|
|
||||||
## Rules of the loop
|
## Rules of the loop
|
||||||
|
|
||||||
|
|||||||
@@ -16,7 +16,7 @@ Muscle growth driven by mechanical tension and metabolic stress over repeated tr
|
|||||||
_Avoid_: Bulking, getting big
|
_Avoid_: Bulking, getting big
|
||||||
|
|
||||||
**Progressive overload**:
|
**Progressive overload**:
|
||||||
Systematically increasing the demand on a muscle over time — via load, volume, or intensity.
|
Systematically increasing the demand on a muscle over time, via load, volume, or intensity.
|
||||||
_Avoid_: Pushing harder, levelling up
|
_Avoid_: Pushing harder, levelling up
|
||||||
|
|
||||||
**RPE (Rate of Perceived Exertion)**:
|
**RPE (Rate of Perceived Exertion)**:
|
||||||
@@ -29,7 +29,7 @@ _Avoid_: Effort score, intensity rating
|
|||||||
- **Add a term only when the user understands it.** The glossary is a record of compressed knowledge, not a dictionary the user reads to learn. If the user has just been introduced to a concept, wait until they can use it correctly before promoting it here.
|
- **Add a term only when the user understands it.** The glossary is a record of compressed knowledge, not a dictionary the user reads to learn. If the user has just been introduced to a concept, wait until they can use it correctly before promoting it here.
|
||||||
- **Be opinionated.** When several words exist for the same concept, pick the best one and list the rest as aliases to avoid. This is how language compresses.
|
- **Be opinionated.** When several words exist for the same concept, pick the best one and list the rest as aliases to avoid. This is how language compresses.
|
||||||
- **Keep definitions tight.** One or two sentences. Define what the term IS, not what it does or how to do it.
|
- **Keep definitions tight.** One or two sentences. Define what the term IS, not what it does or how to do it.
|
||||||
- **Use the glossary's own terms inside definitions.** Once a term is in the glossary, prefer it everywhere — including inside other definitions. This is what makes complex terms easier to grasp later.
|
- **Use the glossary's own terms inside definitions.** Once a term is in the glossary, prefer it everywhere, including inside other definitions. This is what makes complex terms easier to grasp later.
|
||||||
- **Group under subheadings** when natural clusters emerge (e.g. `## Anatomy`, `## Programming`). A flat list is fine when terms cohere.
|
- **Group under subheadings** when natural clusters emerge (e.g. `## Anatomy`, `## Programming`). A flat list is fine when terms cohere.
|
||||||
- **Flag ambiguities explicitly.** If a term is used loosely in the wider field, note the resolution: "In this workspace, 'set' always means a working set — warm-ups are tracked separately."
|
- **Flag ambiguities explicitly.** If a term is used loosely in the wider field, note the resolution: "In this workspace, 'set' always means a working set; warm-ups are tracked separately."
|
||||||
- **Revise as understanding deepens.** A definition the user wrote in week one may be wrong by week six. Update in place; do not leave stale entries.
|
- **Revise as understanding deepens.** A definition the user wrote in week one may be wrong by week six. Update in place; do not leave stale entries.
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
# Learning Record Format
|
# Learning Record Format
|
||||||
|
|
||||||
Learning records live in `./learning-records/` and use sequential numbering: `0001-slug.md`, `0002-slug.md`, etc. Create the directory lazily — only when the first record is written.
|
Learning records live in `./learning-records/` and use sequential numbering: `0001-slug.md`, `0002-slug.md`, etc. Create the directory lazily: only when the first record is written.
|
||||||
|
|
||||||
They are the teaching equivalent of ADRs: they capture non-obvious lessons, key insights, and stated prior knowledge that will steer future sessions. They are used to calculate the zone of proximal development.
|
They are the teaching equivalent of ADRs: they capture non-obvious lessons, key insights, and stated prior knowledge that will steer future sessions. They are used to calculate the zone of proximal development.
|
||||||
|
|
||||||
@@ -12,15 +12,15 @@ They are the teaching equivalent of ADRs: they capture non-obvious lessons, key
|
|||||||
{1-3 sentences: what was learned (or what prior knowledge was established), and why it matters for future sessions.}
|
{1-3 sentences: what was learned (or what prior knowledge was established), and why it matters for future sessions.}
|
||||||
```
|
```
|
||||||
|
|
||||||
That is the whole format. A learning record can be a single paragraph. The value is recording _that_ this is now known and _why_ it changes what to teach next — not in filling out sections.
|
That is the whole format. A learning record can be a single paragraph. The value is recording _that_ this is now known and _why_ it changes what to teach next, not in filling out sections.
|
||||||
|
|
||||||
## Optional sections
|
## Optional sections
|
||||||
|
|
||||||
Only include these when they add genuine value. Most records won't need them.
|
Only include these when they add genuine value. Most records won't need them.
|
||||||
|
|
||||||
- **Status** frontmatter (`active | superseded by LR-NNNN`) — useful when an earlier understanding turns out to be wrong and is replaced.
|
- **Status** frontmatter (`active | superseded by LR-NNNN`): useful when an earlier understanding turns out to be wrong and is replaced.
|
||||||
- **Evidence** — how the user demonstrated the understanding (a question answered, an exercise completed, prior experience cited). Useful when the claim might be revisited.
|
- **Evidence**: how the user demonstrated the understanding (a question answered, an exercise completed, prior experience cited). Useful when the claim might be revisited.
|
||||||
- **Implications** — what this unlocks or rules out for future sessions. Worth recording when non-obvious.
|
- **Implications**: what this unlocks or rules out for future sessions. Worth recording when non-obvious.
|
||||||
|
|
||||||
## Numbering
|
## Numbering
|
||||||
|
|
||||||
@@ -30,16 +30,16 @@ Scan `./learning-records/` for the highest existing number and increment by one.
|
|||||||
|
|
||||||
Write one when any of these is true:
|
Write one when any of these is true:
|
||||||
|
|
||||||
1. **The user demonstrated genuine understanding of something non-trivial** — not just exposure, but evidence they can use the concept correctly. This sets a new floor for what to teach next.
|
1. **The user demonstrated genuine understanding of something non-trivial**: not just exposure, but evidence they can use the concept correctly. This sets a new floor for what to teach next.
|
||||||
2. **The user disclosed prior knowledge** — "I already know X." Record it so future sessions don't re-teach it. Also record the _depth_ claimed.
|
2. **The user disclosed prior knowledge**: "I already know X." Record it so future sessions don't re-teach it. Also record the _depth_ claimed.
|
||||||
3. **A misconception was corrected** — the user previously believed something wrong and now sees why. These are high-value: they predict future stumbling blocks for related topics.
|
3. **A misconception was corrected**: the user previously believed something wrong and now sees why. These are high-value: they predict future stumbling blocks for related topics.
|
||||||
4. **The mission shifted in response to learning** — the user discovered they cared about something different than they thought. Cross-link to [[MISSION.md]] and update it.
|
4. **The mission shifted in response to learning**: the user discovered they cared about something different than they thought. Cross-link to [[MISSION.md]] and update it.
|
||||||
|
|
||||||
### What does _not_ qualify
|
### What does _not_ qualify
|
||||||
|
|
||||||
- Material that was merely covered. Coverage is not learning. Wait for evidence.
|
- Material that was merely covered. Coverage is not learning. Wait for evidence.
|
||||||
- Anything already captured tersely in [[GLOSSARY.md]] as a term definition. Don't duplicate.
|
- Anything already captured tersely in [[GLOSSARY.md]] as a term definition. Don't duplicate.
|
||||||
- Session-by-session activity logs. Learning records are not a journal — they are decision-grade insights.
|
- Session-by-session activity logs. Learning records are not a journal: they are decision-grade insights.
|
||||||
|
|
||||||
## Supersession
|
## Supersession
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
# MISSION.md Format
|
# MISSION.md Format
|
||||||
|
|
||||||
`MISSION.md` lives at the workspace root. It captures the _reason_ the user is learning this topic. Every teaching decision — what to teach next, which resources to surface, which exercises to design — should trace back to this document.
|
`MISSION.md` lives at the workspace root. It captures the _reason_ the user is learning this topic. Every teaching decision (what to teach next, which resources to surface, which exercises to design) should trace back to this document.
|
||||||
|
|
||||||
## Template
|
## Template
|
||||||
|
|
||||||
@@ -8,7 +8,7 @@
|
|||||||
# Mission: {Topic}
|
# Mission: {Topic}
|
||||||
|
|
||||||
## Why
|
## Why
|
||||||
{1-3 sentences. The concrete real-world goal the user is chasing. What changes in their life or work when they have this skill? Avoid abstract framings like "to understand X" — push for the underlying outcome.}
|
{1-3 sentences. The concrete real-world goal the user is chasing. What changes in their life or work when they have this skill? Avoid abstract framings like "to understand X"; push for the underlying outcome.}
|
||||||
|
|
||||||
## Success looks like
|
## Success looks like
|
||||||
- {A specific, observable thing the user will be able to do}
|
- {A specific, observable thing the user will be able to do}
|
||||||
@@ -19,7 +19,7 @@
|
|||||||
- {Time, budget, prior commitments, learning preferences, anything that bounds the approach}
|
- {Time, budget, prior commitments, learning preferences, anything that bounds the approach}
|
||||||
|
|
||||||
## Out of scope
|
## Out of scope
|
||||||
- {Adjacent topics the user explicitly does not want to chase right now — protects the zone of proximal development}
|
- {Adjacent topics the user explicitly does not want to chase right now, protecting the zone of proximal development}
|
||||||
```
|
```
|
||||||
|
|
||||||
## Rules
|
## Rules
|
||||||
@@ -27,5 +27,5 @@
|
|||||||
- **One mission per workspace.** If the user wants to learn two unrelated things, that is two workspaces.
|
- **One mission per workspace.** If the user wants to learn two unrelated things, that is two workspaces.
|
||||||
- **Concrete over abstract.** "Run a half marathon by October" beats "get fitter." "Ship a Rust CLI to my team" beats "learn Rust."
|
- **Concrete over abstract.** "Run a half marathon by October" beats "get fitter." "Ship a Rust CLI to my team" beats "learn Rust."
|
||||||
- **Push back on vagueness.** If the user cannot articulate why, interview them before writing anything. A bad mission is worse than no mission.
|
- **Push back on vagueness.** If the user cannot articulate why, interview them before writing anything. A bad mission is worse than no mission.
|
||||||
- **Revise when reality shifts.** Missions change. When the user's goal moves, update this file — don't leave a stale mission steering future sessions.
|
- **Revise when reality shifts.** Missions change. When the user's goal moves, update this file: don't leave a stale mission steering future sessions.
|
||||||
- **Keep it short.** If `MISSION.md` runs past a screen, it has stopped being a compass and started being a plan.
|
- **Keep it short.** If `MISSION.md` runs past a screen, it has stopped being a compass and started being a plan.
|
||||||
@@ -9,9 +9,9 @@
|
|||||||
|
|
||||||
## Knowledge
|
## Knowledge
|
||||||
|
|
||||||
- [Book: _The Science and Practice of Strength Training_ — Zatsiorsky & Kraemer](https://example.com)
|
- [Book: _The Science and Practice of Strength Training_ by Zatsiorsky & Kraemer](https://example.com)
|
||||||
Foundational text on programming and adaptation. Use for: anything to do with periodisation, recovery, intensity zones.
|
Foundational text on programming and adaptation. Use for: anything to do with periodisation, recovery, intensity zones.
|
||||||
- [Article: "How Much Should I Train?" — Greg Nuckols (Stronger By Science)](https://example.com)
|
- [Article: "How Much Should I Train?" by Greg Nuckols (Stronger By Science)](https://example.com)
|
||||||
Evidence-based review of volume landmarks. Use for: weekly set targets per muscle group.
|
Evidence-based review of volume landmarks. Use for: weekly set targets per muscle group.
|
||||||
|
|
||||||
## Wisdom (Communities)
|
## Wisdom (Communities)
|
||||||
|
|||||||
@@ -46,9 +46,9 @@ Fluency can give the user an illusory sense of mastery, but storage strength is
|
|||||||
|
|
||||||
## Lessons
|
## Lessons
|
||||||
|
|
||||||
A lesson is the main thing you produce — the unit in which knowledge and skills reach the user. Each lesson is one self-contained HTML file, saved to `./lessons/` and titled `0001-<dash-case-name>.html` where the number increments each time.
|
A lesson is the main thing you produce: the unit in which knowledge and skills reach the user. Each lesson is one self-contained HTML file, saved to `./lessons/` and titled `0001-<dash-case-name>.html` where the number increments each time.
|
||||||
|
|
||||||
A lesson should be **beautiful** — clean, readable typography and layout — since the user will return to these later to review. Think Tufte.
|
A lesson should be **beautiful**, with clean, readable typography and layout, since the user will return to these later to review. Think Tufte.
|
||||||
|
|
||||||
The lesson should be short, and completable very quickly. Learners' working memory is very small, and we need to stay within it. But each lesson should give the user a single tangible win that they can build on. It should be directly tied to the mission, and should be in the user's zone of proximal development.
|
The lesson should be short, and completable very quickly. Learners' working memory is very small, and we need to stay within it. But each lesson should give the user a single tangible win that they can build on. It should be directly tied to the mission, and should be in the user's zone of proximal development.
|
||||||
|
|
||||||
@@ -62,9 +62,9 @@ Each lesson should contain a reminder to ask followup questions to the agent. Th
|
|||||||
|
|
||||||
## Assets
|
## Assets
|
||||||
|
|
||||||
Lessons are built from reusable **components**, stored in `./assets/`: stylesheets, quiz widgets, simulators, diagram helpers — anything a second lesson could reuse.
|
Lessons are built from reusable **components**, stored in `./assets/`: stylesheets, quiz widgets, simulators, diagram helpers, and anything else a second lesson could reuse.
|
||||||
|
|
||||||
Reuse is the default, not the exception. Before authoring a lesson, read `./assets/` and build from the components already there. When a lesson needs something new and reusable, write it as a component in `./assets/` and link to it — never inline code a future lesson would duplicate.
|
Reuse is the default, not the exception. Before authoring a lesson, read `./assets/` and build from the components already there. When a lesson needs something new and reusable, write it as a component in `./assets/` and link to it; never inline code a future lesson would duplicate.
|
||||||
|
|
||||||
A shared stylesheet is the first component every workspace earns: every lesson links it, so the lessons look like one consistent course rather than a pile of one-offs. As the workspace grows, so should the component library.
|
A shared stylesheet is the first component every workspace earns: every lesson links it, so the lessons look like one consistent course rather than a pile of one-offs. As the workspace grows, so should the component library.
|
||||||
|
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
# Writing Agent Briefs
|
# Writing Agent Briefs
|
||||||
|
|
||||||
An agent brief is a structured comment posted on a GitHub issue or PR when it moves to `ready-for-agent`. It is the authoritative specification that an AFK agent will work from. The original body and discussion are context — the agent brief is the contract.
|
An agent brief is a structured comment posted on a GitHub issue or PR when it moves to `ready-for-agent`. It is the authoritative specification that an AFK agent will work from. The original body and discussion are context: the agent brief is the contract.
|
||||||
|
|
||||||
The brief states **what the agent should do**, which stretches to both surfaces: for an issue, that's building the change from nothing; for a PR, it's what's left to do *to the existing diff* — finish it, close gaps, address review points. Same principles either way; the PR example below shows the difference.
|
The brief states **what the agent should do**, which stretches to both surfaces: for an issue, that's building the change from nothing; for a PR, it's what's left to do *to the existing diff*: finish it, close gaps, address review points. Same principles either way; the PR example below shows the difference.
|
||||||
|
|
||||||
## Principles
|
## Principles
|
||||||
|
|
||||||
@@ -12,7 +12,7 @@ The issue may sit in `ready-for-agent` for days or weeks. The codebase will chan
|
|||||||
|
|
||||||
- **Do** describe interfaces, types, and behavioral contracts
|
- **Do** describe interfaces, types, and behavioral contracts
|
||||||
- **Do** name specific types, function signatures, or config shapes that the agent should look for or modify
|
- **Do** name specific types, function signatures, or config shapes that the agent should look for or modify
|
||||||
- **Don't** reference file paths — they go stale
|
- **Don't** reference file paths: they go stale
|
||||||
- **Don't** reference line numbers
|
- **Don't** reference line numbers
|
||||||
- **Don't** assume the current implementation structure will remain the same
|
- **Don't** assume the current implementation structure will remain the same
|
||||||
|
|
||||||
@@ -53,9 +53,9 @@ Describe what should happen after the agent's work is complete.
|
|||||||
Be specific about edge cases and error conditions.
|
Be specific about edge cases and error conditions.
|
||||||
|
|
||||||
**Key interfaces:**
|
**Key interfaces:**
|
||||||
- `TypeName` — what needs to change and why
|
- `TypeName`: what needs to change and why
|
||||||
- `functionName()` return type — what it currently returns vs what it should return
|
- `functionName()` return type: what it currently returns vs what it should return
|
||||||
- Config shape — any new configuration options needed
|
- Config shape: any new configuration options needed
|
||||||
|
|
||||||
**Acceptance criteria:**
|
**Acceptance criteria:**
|
||||||
- [ ] Specific, testable criterion 1
|
- [ ] Specific, testable criterion 1
|
||||||
@@ -87,7 +87,7 @@ Truncation should break at the last word boundary before 1024 characters
|
|||||||
and append "..." to indicate truncation.
|
and append "..." to indicate truncation.
|
||||||
|
|
||||||
**Key interfaces:**
|
**Key interfaces:**
|
||||||
- The `SkillMetadata` type's `description` field — no type change needed,
|
- The `SkillMetadata` type's `description` field: no type change needed,
|
||||||
but the validation/processing logic that populates it needs to respect
|
but the validation/processing logic that populates it needs to respect
|
||||||
word boundaries
|
word boundaries
|
||||||
- Any function that reads SKILL.md frontmatter and extracts the description
|
- Any function that reads SKILL.md frontmatter and extracts the description
|
||||||
@@ -125,7 +125,7 @@ requested the feature. When triaging new issues, these files should be
|
|||||||
checked for matches.
|
checked for matches.
|
||||||
|
|
||||||
**Key interfaces:**
|
**Key interfaces:**
|
||||||
- Markdown file format in `.out-of-scope/` — each file should have a
|
- Markdown file format in `.out-of-scope/`: each file should have a
|
||||||
`# Concept Name` heading, a `**Decision:**` line, a `**Reason:**` line,
|
`# Concept Name` heading, a `**Decision:**` line, a `**Reason:**` line,
|
||||||
and a `**Prior requests:**` list with issue links
|
and a `**Prior requests:**` list with issue links
|
||||||
- The triage workflow should read all `.out-of-scope/*.md` files early
|
- The triage workflow should read all `.out-of-scope/*.md` files early
|
||||||
@@ -162,7 +162,7 @@ remain: errors are still printed as human text (not JSON), and the new flag has
|
|||||||
no test coverage.
|
no test coverage.
|
||||||
|
|
||||||
**Desired behavior:**
|
**Desired behavior:**
|
||||||
With `--json`, all output — including errors — is well-formed JSON on stdout,
|
With `--json`, all output (including errors) is well-formed JSON on stdout,
|
||||||
and the command's exit codes are unchanged. The existing human-readable output
|
and the command's exit codes are unchanged. The existing human-readable output
|
||||||
is untouched when the flag is absent.
|
is untouched when the flag is absent.
|
||||||
|
|
||||||
|
|||||||
@@ -2,8 +2,8 @@
|
|||||||
|
|
||||||
The `.out-of-scope/` directory in a repo stores persistent records of rejected feature requests. It serves two purposes:
|
The `.out-of-scope/` directory in a repo stores persistent records of rejected feature requests. It serves two purposes:
|
||||||
|
|
||||||
1. **Institutional memory** — why a feature was rejected, so the reasoning isn't lost when the issue is closed
|
1. **Institutional memory**: why a feature was rejected, so the reasoning isn't lost when the issue is closed
|
||||||
2. **Deduplication** — when a new issue comes in that matches a prior rejection, the skill can surface the previous decision instead of re-litigating it
|
2. **Deduplication**: when a new issue comes in that matches a prior rejection, the skill can surface the previous decision instead of re-litigating it
|
||||||
|
|
||||||
## Directory structure
|
## Directory structure
|
||||||
|
|
||||||
@@ -18,7 +18,7 @@ One file per **concept**, not per issue. Multiple issues requesting the same thi
|
|||||||
|
|
||||||
## File format
|
## File format
|
||||||
|
|
||||||
The file should be written in a relaxed, readable style — more like a short design document than a database entry. Use paragraphs, code samples, and examples to make the reasoning clear and useful to someone encountering it for the first time.
|
The file should be written in a relaxed, readable style, more like a short design document than a database entry. Use paragraphs, code samples, and examples to make the reasoning clear and useful to someone encountering it for the first time.
|
||||||
|
|
||||||
```markdown
|
```markdown
|
||||||
# Dark Mode
|
# Dark Mode
|
||||||
@@ -48,9 +48,9 @@ interface ThemeConfig {
|
|||||||
|
|
||||||
## Prior requests
|
## Prior requests
|
||||||
|
|
||||||
- #42 — "Add dark mode support"
|
- #42: "Add dark mode support"
|
||||||
- #87 — "Night theme for accessibility"
|
- #87: "Night theme for accessibility"
|
||||||
- #134 — "Dark theme option"
|
- #134: "Dark theme option"
|
||||||
```
|
```
|
||||||
|
|
||||||
### Naming the file
|
### Naming the file
|
||||||
@@ -59,31 +59,31 @@ Use a short, descriptive kebab-case name for the concept: `dark-mode.md`, `plugi
|
|||||||
|
|
||||||
### Writing the reason
|
### Writing the reason
|
||||||
|
|
||||||
The reason should be substantive — not "we don't want this" but why. Good reasons reference:
|
The reason should be substantive: not "we don't want this" but why. Good reasons reference:
|
||||||
|
|
||||||
- Project scope or philosophy ("This project focuses on X; theming is a downstream concern")
|
- Project scope or philosophy ("This project focuses on X; theming is a downstream concern")
|
||||||
- Technical constraints ("Supporting this would require Y, which conflicts with our Z architecture")
|
- Technical constraints ("Supporting this would require Y, which conflicts with our Z architecture")
|
||||||
- Strategic decisions ("We chose to use A instead of B because...")
|
- Strategic decisions ("We chose to use A instead of B because...")
|
||||||
|
|
||||||
The reason should be durable. Avoid referencing temporary circumstances ("we're too busy right now") — those aren't real rejections, they're deferrals.
|
The reason should be durable. Avoid referencing temporary circumstances ("we're too busy right now"); those aren't real rejections, they're deferrals.
|
||||||
|
|
||||||
## When to check `.out-of-scope/`
|
## When to check `.out-of-scope/`
|
||||||
|
|
||||||
During triage (Step 1: Gather context), read all files in `.out-of-scope/`. When evaluating a new issue:
|
During triage (Step 1: Gather context), read all files in `.out-of-scope/`. When evaluating a new issue:
|
||||||
|
|
||||||
- Check if the request matches an existing out-of-scope concept
|
- Check if the request matches an existing out-of-scope concept
|
||||||
- Matching is by concept similarity, not keyword — "night theme" matches `dark-mode.md`
|
- Matching is by concept similarity, not keyword: "night theme" matches `dark-mode.md`
|
||||||
- If there's a match, surface it to the maintainer: "This is similar to `.out-of-scope/dark-mode.md` — we rejected this before because [reason]. Do you still feel the same way?"
|
- If there's a match, surface it to the maintainer: "This is similar to `.out-of-scope/dark-mode.md`. We rejected this before because [reason]. Do you still feel the same way?"
|
||||||
|
|
||||||
The maintainer may:
|
The maintainer may:
|
||||||
|
|
||||||
- **Confirm** — the new issue gets added to the existing file's "Prior requests" list, then closed
|
- **Confirm**: the new issue gets added to the existing file's "Prior requests" list, then closed
|
||||||
- **Reconsider** — the out-of-scope file gets deleted or updated, and the issue proceeds through normal triage
|
- **Reconsider**: the out-of-scope file gets deleted or updated, and the issue proceeds through normal triage
|
||||||
- **Disagree** — the issues are related but distinct, proceed with normal triage
|
- **Disagree**: the issues are related but distinct, proceed with normal triage
|
||||||
|
|
||||||
## When to write to `.out-of-scope/`
|
## When to write to `.out-of-scope/`
|
||||||
|
|
||||||
Only when an **enhancement** (not a bug) is *rejected* as `wontfix`. This applies to enhancement PRs exactly as it does to issues — a rejected PR is recorded here so the same request doesn't return as fresh code.
|
Only when an **enhancement** (not a bug) is *rejected* as `wontfix`. This applies to enhancement PRs exactly as it does to issues: a rejected PR is recorded here so the same request doesn't return as fresh code.
|
||||||
|
|
||||||
Do **not** write here when something is closed as `wontfix` because it's **already implemented**. That's a built feature, not a rejected one; recording it would poison the dedup checks with false rejections. Instead, the closing comment points to where the feature already lives.
|
Do **not** write here when something is closed as `wontfix` because it's **already implemented**. That's a built feature, not a rejected one; recording it would poison the dedup checks with false rejections. Instead, the closing comment points to where the feature already lives.
|
||||||
|
|
||||||
@@ -101,5 +101,5 @@ The flow:
|
|||||||
If the maintainer changes their mind about a previously rejected concept:
|
If the maintainer changes their mind about a previously rejected concept:
|
||||||
|
|
||||||
- Delete the `.out-of-scope/` file
|
- Delete the `.out-of-scope/` file
|
||||||
- The skill does not need to reopen old issues — they're historical records
|
- The skill does not need to reopen old issues; they're historical records
|
||||||
- The new issue that triggered the reconsideration proceeds through normal triage
|
- The new issue that triggered the reconsideration proceeds through normal triage
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
name: triage
|
name: triage
|
||||||
description: Move issues and external PRs through a state machine of triage roles — categorise, verify, grill if needed, and write agent-ready briefs.
|
description: Move issues and external PRs through a state machine of triage roles, categorise, verify, grill if needed, and write agent-ready briefs.
|
||||||
disable-model-invocation: true
|
disable-model-invocation: true
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -8,7 +8,7 @@ disable-model-invocation: true
|
|||||||
|
|
||||||
Move issues on the project issue tracker through a small state machine of triage roles.
|
Move issues on the project issue tracker through a small state machine of triage roles.
|
||||||
|
|
||||||
If this repo treats external pull requests as a request surface (see the issue-tracker config), triage covers them too: **a PR is an issue with attached code** — same roles, same states, same machine, with a few deltas marked "for a PR" below. Resolve a bare `#42` to an issue or PR per the tracker config.
|
If this repo treats external pull requests as a request surface (see the issue-tracker config), triage covers them too: **a PR is an issue with attached code**, using the same roles, same states, and same machine, with a few deltas marked "for a PR" below. Resolve a bare `#42` to an issue or PR per the tracker config.
|
||||||
|
|
||||||
Every comment or issue posted to the issue tracker during triage **must** start with this disclaimer:
|
Every comment or issue posted to the issue tracker during triage **must** start with this disclaimer:
|
||||||
|
|
||||||
@@ -18,31 +18,31 @@ Every comment or issue posted to the issue tracker during triage **must** start
|
|||||||
|
|
||||||
## Reference docs
|
## Reference docs
|
||||||
|
|
||||||
- [AGENT-BRIEF.md](AGENT-BRIEF.md) — how to write durable agent briefs
|
- [AGENT-BRIEF.md](AGENT-BRIEF.md): how to write durable agent briefs
|
||||||
- [OUT-OF-SCOPE.md](OUT-OF-SCOPE.md) — how the `.out-of-scope/` knowledge base works
|
- [OUT-OF-SCOPE.md](OUT-OF-SCOPE.md): how the `.out-of-scope/` knowledge base works
|
||||||
|
|
||||||
## Roles
|
## Roles
|
||||||
|
|
||||||
Two **category** roles:
|
Two **category** roles:
|
||||||
|
|
||||||
- `bug` — something is broken
|
- `bug`: something is broken
|
||||||
- `enhancement` — new feature or improvement
|
- `enhancement`: new feature or improvement
|
||||||
|
|
||||||
Five **state** roles:
|
Five **state** roles:
|
||||||
|
|
||||||
- `needs-triage` — maintainer needs to evaluate
|
- `needs-triage`: maintainer needs to evaluate
|
||||||
- `needs-info` — waiting on reporter for more information
|
- `needs-info`: waiting on reporter for more information
|
||||||
- `ready-for-agent` — fully specified, ready for an AFK agent
|
- `ready-for-agent`: fully specified, ready for an AFK agent
|
||||||
- `ready-for-human` — needs human implementation
|
- `ready-for-human`: needs human implementation
|
||||||
- `wontfix` — will not be actioned
|
- `wontfix`: will not be actioned
|
||||||
|
|
||||||
For a PR, the same states read against the attached code: `ready-for-agent` means a brief is attached and an agent should take the next step on the diff; `ready-for-human` means it's ready for a human to merge.
|
For a PR, the same states read against the attached code: `ready-for-agent` means a brief is attached and an agent should take the next step on the diff; `ready-for-human` means it's ready for a human to merge.
|
||||||
|
|
||||||
Every triaged issue should carry exactly one category role and one state role. If state roles conflict, flag it and ask the maintainer before doing anything else.
|
Every triaged issue should carry exactly one category role and one state role. If state roles conflict, flag it and ask the maintainer before doing anything else.
|
||||||
|
|
||||||
These are canonical role names — the actual label strings used in the issue tracker may differ. The mapping should have been provided to you. If not, tell the user to run `/setup-matt-pocock-skills`.
|
These are canonical role names. The actual label strings used in the issue tracker may differ. The mapping should have been provided to you. If not, tell the user to run `/setup-matt-pocock-skills`.
|
||||||
|
|
||||||
State transitions: an unlabeled issue normally goes to `needs-triage` first; from there it moves to `needs-info`, `ready-for-agent`, `ready-for-human`, or `wontfix`. `needs-info` returns to `needs-triage` once the reporter replies. The maintainer can override at any time — flag transitions that look unusual and ask before proceeding.
|
State transitions: an unlabeled issue normally goes to `needs-triage` first; from there it moves to `needs-info`, `ready-for-agent`, `ready-for-human`, or `wontfix`. `needs-info` returns to `needs-triage` once the reporter replies. The maintainer can override at any time; flag transitions that look unusual and ask before proceeding.
|
||||||
|
|
||||||
## Invocation
|
## Invocation
|
||||||
|
|
||||||
@@ -57,33 +57,33 @@ The maintainer invokes `/triage` and describes what they want in natural languag
|
|||||||
|
|
||||||
Query the issue tracker and present three buckets, oldest first:
|
Query the issue tracker and present three buckets, oldest first:
|
||||||
|
|
||||||
1. **Unlabeled** — never triaged.
|
1. **Unlabeled**: never triaged.
|
||||||
2. **`needs-triage`** — evaluation in progress.
|
2. **`needs-triage`**: evaluation in progress.
|
||||||
3. **`needs-info` with reporter activity since the last triage notes** — needs re-evaluation.
|
3. **`needs-info` with reporter activity since the last triage notes**: needs re-evaluation.
|
||||||
|
|
||||||
When PRs are in scope, include external PRs in these buckets and tag each line `[PR]` or `[issue]`. Discovery surfaces only *external* PRs (the tracker config defines who counts as external) — a collaborator's in-flight PR is not triage work. This filter is discovery-only; an explicitly named PR is always triaged regardless of author.
|
When PRs are in scope, include external PRs in these buckets and tag each line `[PR]` or `[issue]`. Discovery surfaces only *external* PRs (the tracker config defines who counts as external), so a collaborator's in-flight PR is not triage work. This filter is discovery-only; an explicitly named PR is always triaged regardless of author.
|
||||||
|
|
||||||
Show counts and a one-line summary per item. Let the maintainer pick.
|
Show counts and a one-line summary per item. Let the maintainer pick.
|
||||||
|
|
||||||
## Triage a specific issue or PR
|
## Triage a specific issue or PR
|
||||||
|
|
||||||
1. **Gather context.** Read the full issue or PR (body, comments, labels, author, dates; for a PR, the diff too). Parse any prior triage notes so you don't re-ask resolved questions. Explore the codebase using the project's domain glossary, respecting ADRs in the area. Run two checks against the codebase: (a) **redundancy** — search for an existing implementation of the requested behavior by domain concept (not just the request's wording), and report where you looked. If found, it's an already-implemented `wontfix` (step 5). (b) **prior rejection** — read `.out-of-scope/*.md` and surface any that resembles this request.
|
1. **Gather context.** Read the full issue or PR (body, comments, labels, author, dates; for a PR, the diff too). Parse any prior triage notes so you don't re-ask resolved questions. Explore the codebase using the project's domain glossary, respecting ADRs in the area. Run two checks against the codebase: (a) **redundancy**: search for an existing implementation of the requested behavior by domain concept (not just the request's wording), and report where you looked. If found, it's an already-implemented `wontfix` (step 5). (b) **prior rejection**: read `.out-of-scope/*.md` and surface any that resembles this request.
|
||||||
|
|
||||||
2. **Recommend.** Tell the maintainer your category and state recommendation with reasoning, plus a brief codebase summary relevant to the request — including whether it's already implemented. Wait for direction.
|
2. **Recommend.** Tell the maintainer your category and state recommendation with reasoning, plus a brief codebase summary relevant to the request (including whether it's already implemented). Wait for direction.
|
||||||
|
|
||||||
3. **Verify the claim.** Before any grilling, check that the claim holds up. For a bug, reproduce it from the reporter's steps. For a PR, confirm the diff does what it claims — check it out, run the relevant tests or commands. Report what happened: confirmed (with code path), failed, or insufficient detail (a strong `needs-info` signal). A confirmed verification makes a much stronger agent brief.
|
3. **Verify the claim.** Before any grilling, check that the claim holds up. For a bug, reproduce it from the reporter's steps. For a PR, confirm the diff does what it claims: check it out, run the relevant tests or commands. Report what happened: confirmed (with code path), failed, or insufficient detail (a strong `needs-info` signal). A confirmed verification makes a much stronger agent brief.
|
||||||
|
|
||||||
4. **Grill (if needed).** If the request needs fleshing out, call the Skill tool twice, for "grilling" and "domain-modeling" — grill it into shape a round of questions at a time, sharpening domain terms and updating `CONTEXT.md`/ADRs inline as decisions land.
|
4. **Grill (if needed).** If the request needs fleshing out, call the Skill tool twice, for "grilling" and "domain-modeling", and grill it into shape a round of questions at a time, sharpening domain terms and updating `CONTEXT.md`/ADRs inline as decisions land.
|
||||||
|
|
||||||
5. **Apply the outcome:**
|
5. **Apply the outcome:**
|
||||||
- `ready-for-agent` — post an agent brief comment ([AGENT-BRIEF.md](AGENT-BRIEF.md)).
|
- `ready-for-agent`: post an agent brief comment ([AGENT-BRIEF.md](AGENT-BRIEF.md)).
|
||||||
- `ready-for-human` — same structure as an agent brief, but note why it can't be delegated (judgment calls, external access, design decisions, manual testing).
|
- `ready-for-human`: same structure as an agent brief, but note why it can't be delegated (judgment calls, external access, design decisions, manual testing).
|
||||||
- `needs-info` — post triage notes (template below).
|
- `needs-info`: post triage notes (template below).
|
||||||
- `wontfix` — close, with the comment depending on *why*:
|
- For `wontfix`, close the issue, with the comment depending on *why*:
|
||||||
- **Already implemented** — the change already exists in the codebase. Point to where it lives; do **not** write to `.out-of-scope/` (that KB is for *rejected* requests, not built ones).
|
- **Already implemented**: the change already exists in the codebase. Point to where it lives; do **not** write to `.out-of-scope/` (that KB is for *rejected* requests, not built ones).
|
||||||
- **Rejected (bug)** — polite explanation, then close.
|
- **Rejected (bug)**: give a polite explanation, then close.
|
||||||
- **Rejected (enhancement)** — write to `.out-of-scope/`, link to it from a comment, then close ([OUT-OF-SCOPE.md](OUT-OF-SCOPE.md)).
|
- **Rejected (enhancement)**: write to `.out-of-scope/`, link to it from a comment, then close ([OUT-OF-SCOPE.md](OUT-OF-SCOPE.md)).
|
||||||
- `needs-triage` — apply the role. Optional comment if there's partial progress.
|
- `needs-triage`: apply the role. Optional comment if there's partial progress.
|
||||||
|
|
||||||
## Quick state override
|
## Quick state override
|
||||||
|
|
||||||
|
|||||||
@@ -1,21 +1,21 @@
|
|||||||
---
|
---
|
||||||
name: writing-beats
|
name: writing-beats
|
||||||
description: Writing, exploit — assemble raw material into a journey of beats, grounding each term before a beat leans on it.
|
description: Writing, exploit; assemble raw material into a journey of beats, grounding each term before a beat leans on it.
|
||||||
disable-model-invocation: true
|
disable-model-invocation: true
|
||||||
---
|
---
|
||||||
|
|
||||||
<what-to-do>
|
<what-to-do>
|
||||||
|
|
||||||
The user has passed (or will pass) a markdown file of raw material. This is **exploit**: the exploring is done, the pile is fixed — commit to a path through it and mine the pile to fill each beat.
|
The user has passed (or will pass) a markdown file of raw material. This is **exploit**: the exploring is done, the pile is fixed. Commit to a path through it and mine the pile to fill each beat.
|
||||||
|
|
||||||
If the user did not say where to save the article, ask once and remember the path.
|
If the user did not say where to save the article, ask once and remember the path.
|
||||||
|
|
||||||
Then run a beat-by-beat journey, choose-your-own-adventure style:
|
Then run a beat-by-beat journey, choose-your-own-adventure style:
|
||||||
|
|
||||||
1. **Establish the prerequisites.** Before any beats, settle with the user what the audience already knows walking in — the concepts that are **grounded** from the start. Everything else must be grounded by a beat before a later beat can use it. See [Grounding](#grounding).
|
1. **Establish the prerequisites.** Before any beats, settle with the user what the audience already knows walking in: the concepts that are **grounded** from the start. Everything else must be grounded by a beat before a later beat can use it. See [Grounding](#grounding).
|
||||||
2. Write 2–3 candidate **starting beats**, drawn from the raw material. Each is a different entry point into the article. Each may only lean on grounded concepts; note what new concepts each one grounds. Show the user the beats before writing to the article file. The user picks one. Preview what beats that pick unlocks — as if the user is seeing a little way down the path.
|
2. Write 2–3 candidate **starting beats**, drawn from the raw material. Each is a different entry point into the article. Each may only lean on grounded concepts; note what new concepts each one grounds. Show the user the beats before writing to the article file. The user picks one. Preview what beats that pick unlocks, as if the user is seeing a little way down the path.
|
||||||
3. Once the user picks a starting beat, write **only that beat** to the article file. A beat may be one sentence or several paragraphs — whatever that beat naturally is. Stop there.
|
3. Once the user picks a starting beat, write **only that beat** to the article file. A beat may be one sentence or several paragraphs, whatever that beat naturally is. Stop there.
|
||||||
4. Re-read the article file from disk. Then offer 2–3 candidate **next beats** — different directions the journey could pivot to from where the article now stands. Each must be reachable from the current grounded set; note what each one grounds.
|
4. Re-read the article file from disk. Then offer 2–3 candidate **next beats**: different directions the journey could pivot to from where the article now stands. Each must be reachable from the current grounded set; note what each one grounds.
|
||||||
5. Loop steps 3–5 until the article reaches a natural end.
|
5. Loop steps 3–5 until the article reaches a natural end.
|
||||||
|
|
||||||
</what-to-do>
|
</what-to-do>
|
||||||
@@ -24,22 +24,22 @@ Then run a beat-by-beat journey, choose-your-own-adventure style:
|
|||||||
|
|
||||||
## Grounding
|
## Grounding
|
||||||
|
|
||||||
Every **concept** has to be **grounded** before a beat can lean on it: the audience either walked in knowing it or met it in an earlier beat. A beat that reaches for an ungrounded concept loses the reader — that is the one move the journey can't make. The unit is the concept, not the word for it: a beat can lean on an idea the reader lacks even with no jargon in sight. Where a concept has a name — a **term** — grounding it means landing the idea and the term together.
|
Every **concept** has to be **grounded** before a beat can lean on it: the audience either walked in knowing it or met it in an earlier beat. A beat that reaches for an ungrounded concept loses the reader; that is the one move the journey can't make. The unit is the concept, not the word for it: a beat can lean on an idea the reader lacks even with no jargon in sight. Where a concept has a name (a **term**), grounding it means landing the idea and the term together.
|
||||||
|
|
||||||
A concept gets grounded one of two ways:
|
A concept gets grounded one of two ways:
|
||||||
|
|
||||||
- **Prerequisite** — grounded before the first beat. The audience brings it. Fixed at the start.
|
- **Prerequisite**: grounded before the first beat. The audience brings it. Fixed at the start.
|
||||||
- **Introduced** — a beat establishes it, and from then on it's grounded for every later beat.
|
- **Introduced**: a beat establishes it, and from then on it's grounded for every later beat.
|
||||||
|
|
||||||
So each beat does two jobs: it **requires** concepts that are already grounded, and it **grounds** new ones. Keep a running list of what's grounded so far, and update it each time a beat lands.
|
So each beat does two jobs: it **requires** concepts that are already grounded, and it **grounds** new ones. Keep a running list of what's grounded so far, and update it each time a beat lands.
|
||||||
|
|
||||||
This is what shapes the choose-your-own-adventure. A candidate beat is only reachable if everything it requires is already grounded; picking a beat that grounds concept X unlocks every beat that was waiting on X. When you offer next beats, they must all be reachable from the current grounded set — and say what each one grounds, so the user can see which paths it opens.
|
This is what shapes the choose-your-own-adventure. A candidate beat is only reachable if everything it requires is already grounded; picking a beat that grounds concept X unlocks every beat that was waiting on X. When you offer next beats, they must all be reachable from the current grounded set, and say what each one grounds, so the user can see which paths it opens.
|
||||||
|
|
||||||
The big lever is what you make a prerequisite versus what you ground inside the piece. Demand too much up front and you shut out readers who don't have it; ground too much inside and the early beats drown in definitions. Settle this with the user when you establish prerequisites, and revisit it whenever a tempting beat turns out to require a concept nothing has grounded yet — the fix is either a grounding beat before it, or promoting the concept to a prerequisite.
|
The big lever is what you make a prerequisite versus what you ground inside the piece. Demand too much up front and you shut out readers who don't have it; ground too much inside and the early beats drown in definitions. Settle this with the user when you establish prerequisites, and revisit it whenever a tempting beat turns out to require a concept nothing has grounded yet: the fix is either a grounding beat before it, or promoting the concept to a prerequisite.
|
||||||
|
|
||||||
## What is a beat
|
## What is a beat
|
||||||
|
|
||||||
A beat is one move in the journey. It does one thing — sets a scene, lands a point, asks a question, drops an aside, twists the angle. Then it stops, leaving the reader at a place where the next beat can pivot.
|
A beat is one move in the journey. It does one thing: sets a scene, lands a point, asks a question, drops an aside, twists the angle. Then it stops, leaving the reader at a place where the next beat can pivot.
|
||||||
|
|
||||||
A beat is sized by what it needs:
|
A beat is sized by what it needs:
|
||||||
|
|
||||||
@@ -47,7 +47,7 @@ A beat is sized by what it needs:
|
|||||||
- A short paragraph if the move needs setup.
|
- A short paragraph if the move needs setup.
|
||||||
- Multiple paragraphs if the beat is a self-contained vignette, argument, or example.
|
- Multiple paragraphs if the beat is a self-contained vignette, argument, or example.
|
||||||
|
|
||||||
If a "beat" needs five paragraphs and three subheadings, it's not a beat — it's two beats glued together. Split it.
|
If a "beat" needs five paragraphs and three subheadings, it's not a beat; it's two beats glued together. Split it.
|
||||||
|
|
||||||
## Pulling from the pile
|
## Pulling from the pile
|
||||||
|
|
||||||
@@ -55,13 +55,13 @@ Pull material from the raw pile to populate each beat. You can paraphrase, split
|
|||||||
|
|
||||||
## Ending the journey
|
## Ending the journey
|
||||||
|
|
||||||
The article ends when the journey is complete — not when the pile is empty. Most piles will have leftover fragments that don't make it in. That is fine; that is the point of having more raw material than you need.
|
The article ends when the journey is complete, not when the pile is empty. Most piles will have leftover fragments that don't make it in. That is fine; that is the point of having more raw material than you need.
|
||||||
|
|
||||||
## Writing rhythm
|
## Writing rhythm
|
||||||
|
|
||||||
- Append one beat at a time. Never write ahead.
|
- Append one beat at a time. Never write ahead.
|
||||||
- Re-read the article file from disk before every write. Preserve user edits absolutely.
|
- Re-read the article file from disk before every write. Preserve user edits absolutely.
|
||||||
- If the user edits a previous beat substantially, let it change what comes next.
|
- If the user edits a previous beat substantially, let it change what comes next.
|
||||||
- If the user says "rewrite that beat" or "go back and try a different beat 3", do it — edit in place, leave the rest alone.
|
- If the user says "rewrite that beat" or "go back and try a different beat 3", do it: edit in place, leave the rest alone.
|
||||||
|
|
||||||
</supporting-info>
|
</supporting-info>
|
||||||
@@ -1,12 +1,12 @@
|
|||||||
---
|
---
|
||||||
name: writing-fragments
|
name: writing-fragments
|
||||||
description: Writing, explore — mine raw fragments, no structure yet.
|
description: "Writing, explore: mine raw fragments, no structure yet."
|
||||||
disable-model-invocation: true
|
disable-model-invocation: true
|
||||||
---
|
---
|
||||||
|
|
||||||
<what-to-do>
|
<what-to-do>
|
||||||
|
|
||||||
This is pure **explore**: widen the space of what could be written without committing to structure — committing is _exploit_, a separate skill's job. Run a grilling session that produces fragments, interviewing the user relentlessly about whatever they want to write about. Imposing phases, outlines, or article structure is out of scope here.
|
This is pure **explore**: widen the space of what could be written without committing to structure. Committing is _exploit_, a separate skill's job. Run a grilling session that produces fragments, interviewing the user relentlessly about whatever they want to write about. Imposing phases, outlines, or article structure is out of scope here.
|
||||||
|
|
||||||
As fragments emerge from either side of the conversation, append them to a single markdown file.
|
As fragments emerge from either side of the conversation, append them to a single markdown file.
|
||||||
|
|
||||||
@@ -14,7 +14,7 @@ If the user did not pass a path, ask once where to save the document, then remem
|
|||||||
|
|
||||||
Capture fragments from the very first thing the user says, including the initial prompt.
|
Capture fragments from the very first thing the user says, including the initial prompt.
|
||||||
|
|
||||||
On first write, put a single H1 at the top with a working title (it can change later) and nothing else — no metadata, no TOC, no date.
|
On first write, put a single H1 at the top with a working title (it can change later) and nothing else: no metadata, no TOC, no date.
|
||||||
|
|
||||||
</what-to-do>
|
</what-to-do>
|
||||||
|
|
||||||
@@ -22,7 +22,7 @@ On first write, put a single H1 at the top with a working title (it can change l
|
|||||||
|
|
||||||
## What is a fragment
|
## What is a fragment
|
||||||
|
|
||||||
A fragment is any piece of text that might survive into the final article. It must be _readable by the author_ — the author can tell what it means — but it does not need to define its terms or be comprehensible to a cold reader. The bar is "is this a piece of good writing?", not "is this a self-contained argument?"
|
A fragment is any piece of text that might survive into the final article. It must be _readable by the author_ (the author can tell what it means), but it does not need to define its terms or be comprehensible to a cold reader. The bar is "is this a piece of good writing?", not "is this a self-contained argument?"
|
||||||
|
|
||||||
Fragments are deliberately heterogeneous. Examples of what could be a fragment:
|
Fragments are deliberately heterogeneous. Examples of what could be a fragment:
|
||||||
|
|
||||||
@@ -33,9 +33,9 @@ Fragments are deliberately heterogeneous. Examples of what could be a fragment:
|
|||||||
- A quote, a piece of dialogue, an overheard line.
|
- A quote, a piece of dialogue, an overheard line.
|
||||||
- A list of related observations that hang together by feel.
|
- A list of related observations that hang together by feel.
|
||||||
- A complaint, a confession, a punchline.
|
- A complaint, a confession, a punchline.
|
||||||
- A **leading word** — a compact metaphor or coinage the whole piece can hang on (one term that names the idea, the way _tracer bullets_ or _fog of war_ names a whole pattern).
|
- A **leading word**: a compact metaphor or coinage the whole piece can hang on (one term that names the idea, the way _tracer bullets_ or _fog of war_ names a whole pattern).
|
||||||
|
|
||||||
Of these, the leading word is the most valuable fragment to land. It is load-bearing: name the right one in explore and it shapes the structure, the transitions, and the title later — paying dividends through the entire exploit phase. When the conversation circles a recurring idea, push to coin a word for it.
|
Of these, the leading word is the most valuable fragment to land. It is load-bearing: name the right one in explore and it shapes the structure, the transitions, and the title later, paying dividends through the entire exploit phase. When the conversation circles a recurring idea, push to coin a word for it.
|
||||||
|
|
||||||
The novelist's diary is the model: years of unstructured noticings that later get mined for raw material. Fragments are noticings.
|
The novelist's diary is the model: years of unstructured noticings that later get mined for raw material. Fragments are noticings.
|
||||||
|
|
||||||
@@ -46,7 +46,7 @@ The novelist's diary is the model: years of unstructured noticings that later ge
|
|||||||
|
|
||||||
A first fragment lives here.
|
A first fragment lives here.
|
||||||
|
|
||||||
It can be multiple paragraphs. It can include lists, code, quotes — whatever
|
It can be multiple paragraphs. It can include lists, code, quotes: whatever
|
||||||
shape the fragment naturally takes.
|
shape the fragment naturally takes.
|
||||||
|
|
||||||
---
|
---
|
||||||
@@ -72,7 +72,7 @@ Fragments are separated by a horizontal rule (`\n---\n`). No headings inside the
|
|||||||
|
|
||||||
Append silently. Don't ask permission for each fragment. Mention what you added in passing ("adding that"), but don't interrupt the conversation with save dialogs.
|
Append silently. Don't ask permission for each fragment. Mention what you added in passing ("adding that"), but don't interrupt the conversation with save dialogs.
|
||||||
|
|
||||||
Before every write: re-read the file from disk. The user may have edited, reordered, or deleted fragments between turns — preserve their changes. Never overwrite the file; only append (or, if the user asks, edit a specific fragment in place).
|
Before every write: re-read the file from disk. The user may have edited, reordered, or deleted fragments between turns, so preserve their changes. Never overwrite the file; only append (or, if the user asks, edit a specific fragment in place).
|
||||||
|
|
||||||
The user can say "cut the last one", "rewrite that one sharper", "merge those two" at any time. Treat those as first-class instructions.
|
The user can say "cut the last one", "rewrite that one sharper", "merge those two" at any time. Treat those as first-class instructions.
|
||||||
|
|
||||||
|
|||||||
@@ -1,14 +1,14 @@
|
|||||||
---
|
---
|
||||||
name: writing-shape
|
name: writing-shape
|
||||||
description: Writing, exploit — shape raw material into an article, paragraph by paragraph.
|
description: "Writing, exploit: shape raw material into an article, paragraph by paragraph."
|
||||||
disable-model-invocation: true
|
disable-model-invocation: true
|
||||||
---
|
---
|
||||||
|
|
||||||
<what-to-do>
|
<what-to-do>
|
||||||
|
|
||||||
The user has passed (or will pass) a markdown file of raw material. Treat it as the input pile — anything from a tidy list of fragments to a wall of unstructured prose to a transcript. The format does not matter. Read it end-to-end before doing anything else.
|
The user has passed (or will pass) a markdown file of raw material. Treat it as the input pile: anything from a tidy list of fragments to a wall of unstructured prose to a transcript. The format does not matter. Read it end-to-end before doing anything else.
|
||||||
|
|
||||||
Then run a shaping session that produces a separate article document. This is **exploit**: the exploring is done, the pile is fixed — commit to a structure and mine the pile to fill it. Do not edit the raw material file — it is read-only to this skill.
|
Then run a shaping session that produces a separate article document. This is **exploit**: the exploring is done, the pile is fixed: commit to a structure and mine the pile to fill it. Do not edit the raw material file: it is read-only to this skill.
|
||||||
|
|
||||||
If the user did not say where to save the article, ask once and remember the path.
|
If the user did not say where to save the article, ask once and remember the path.
|
||||||
|
|
||||||
@@ -19,22 +19,22 @@ If the user did not say where to save the article, ask once and remember the pat
|
|||||||
## The loop
|
## The loop
|
||||||
|
|
||||||
1. **Read the pile.** Read the input file in full. Form a sense of what's in it.
|
1. **Read the pile.** Read the input file in full. Form a sense of what's in it.
|
||||||
2. **Establish the prerequisites.** Settle with the user what the reader knows walking in — the concepts that are **grounded** from the start. Everything else must be grounded by a block before a later block can lean on it. See [Grounding](#grounding).
|
2. **Establish the prerequisites.** Settle with the user what the reader knows walking in: the concepts that are **grounded** from the start. Everything else must be grounded by a block before a later block can lean on it. See [Grounding](#grounding).
|
||||||
3. **Draft 2–3 candidate openings.** Each opening should imply a different thesis or angle for the article. Show all of them. Force the user to pick or compose a hybrid. The chosen opening defines what the rest of the article must do.
|
3. **Draft 2–3 candidate openings.** Each opening should imply a different thesis or angle for the article. Show all of them. Force the user to pick or compose a hybrid. The chosen opening defines what the rest of the article must do.
|
||||||
4. **Grow paragraph by paragraph.** After the opening lands, ask "given this opening, what does the reader need to hear next?" Pull material from the pile to answer. The next block may only lean on grounded concepts, and grounds new ones as it lands. Argue about the form the next block takes — a paragraph, a list, a table, a callout, a quote, a code block. Each format choice should be deliberate and defensible.
|
4. **Grow paragraph by paragraph.** After the opening lands, ask "given this opening, what does the reader need to hear next?" Pull material from the pile to answer. The next block may only lean on grounded concepts, and grounds new ones as it lands. Argue about the form the next block takes: a paragraph, a list, a table, a callout, a quote, a code block. Each format choice should be deliberate and defensible.
|
||||||
5. **Append to the article file as you go.** Don't batch. Write each agreed paragraph or block immediately so the user can see the article taking shape.
|
5. **Append to the article file as you go.** Don't batch. Write each agreed paragraph or block immediately so the user can see the article taking shape.
|
||||||
6. **Loop step 4 until the article is done.** The user decides when it's done.
|
6. **Loop step 4 until the article is done.** The user decides when it's done.
|
||||||
|
|
||||||
## Grounding
|
## Grounding
|
||||||
|
|
||||||
Every **concept** has to be **grounded** before a block can lean on it: the reader either walked in knowing it or met it in an earlier block. A block that reaches for an ungrounded concept loses the reader. The unit is the concept, not the word for it — a block can lean on an idea the reader lacks even with no jargon in sight. Where a concept has a name — a **term** — grounding it means landing the idea and the term together.
|
Every **concept** has to be **grounded** before a block can lean on it: the reader either walked in knowing it or met it in an earlier block. A block that reaches for an ungrounded concept loses the reader. The unit is the concept, not the word for it: a block can lean on an idea the reader lacks even with no jargon in sight. Where a concept has a name (a **term**), grounding it means landing the idea and the term together.
|
||||||
|
|
||||||
A concept gets grounded one of two ways:
|
A concept gets grounded one of two ways:
|
||||||
|
|
||||||
- **Prerequisite** — grounded before the opening. The reader brings it. Fixed at the start.
|
- **Prerequisite**: grounded before the opening. The reader brings it. Fixed at the start.
|
||||||
- **Introduced** — a block establishes it, and from then on it's grounded for the rest of the article.
|
- **Introduced**: a block establishes it, and from then on it's grounded for the rest of the article.
|
||||||
|
|
||||||
Keep a running list of what's grounded. When you ask "what does the reader need to hear next?", an ungrounded concept the next move needs is itself the answer: ground it first — here or in an earlier block — or you can't make the move. This is the gap-naming of [Pulling from the pile](#pulling-from-the-pile) one level up: there the pile is missing material; here the article is missing a foundation.
|
Keep a running list of what's grounded. When you ask "what does the reader need to hear next?", an ungrounded concept the next move needs is itself the answer: ground it first (here or in an earlier block) or you can't make the move. This is the gap-naming of [Pulling from the pile](#pulling-from-the-pile) one level up: there the pile is missing material; here the article is missing a foundation.
|
||||||
|
|
||||||
The lever is what you make a prerequisite versus what you ground inside the article. Demand too much up front and you shut readers out; ground too much inside and the opening drowns in definitions. Settle it with the user when you establish prerequisites.
|
The lever is what you make a prerequisite versus what you ground inside the article. Demand too much up front and you shut readers out; ground too much inside and the opening drowns in definitions. Settle it with the user when you establish prerequisites.
|
||||||
|
|
||||||
@@ -47,28 +47,28 @@ Specific moves to keep using:
|
|||||||
- "What does this paragraph do for the reader that the previous one didn't?"
|
- "What does this paragraph do for the reader that the previous one didn't?"
|
||||||
- "If I cut this, what breaks?"
|
- "If I cut this, what breaks?"
|
||||||
- "Is this prose, or should it be a list? Why prose?"
|
- "Is this prose, or should it be a list? Why prose?"
|
||||||
- "This sentence is doing two jobs — split it or pick one."
|
- "This sentence is doing two jobs: split it or pick one."
|
||||||
- "The opening promised X. We've drifted to Y. Either re-thread it or change the opening."
|
- "The opening promised X. We've drifted to Y. Either re-thread it or change the opening."
|
||||||
|
|
||||||
## Pulling from the pile
|
## Pulling from the pile
|
||||||
|
|
||||||
Treat the raw material as a quarry, not a script. Pull a fragment, rework it to fit the surrounding paragraph, and place it. A fragment may be split across multiple paragraphs, merged with another, or paraphrased. The pile's job is to be mined; the article's job is to read as one voice.
|
Treat the raw material as a quarry, not a script. Pull a fragment, rework it to fit the surrounding paragraph, and place it. A fragment may be split across multiple paragraphs, merged with another, or paraphrased. The pile's job is to be mined; the article's job is to read as one voice.
|
||||||
|
|
||||||
If the pile lacks something the article needs, name the gap explicitly: "We need an example here and the pile doesn't have one — give me one now or we cut this section."
|
If the pile lacks something the article needs, name the gap explicitly: "We need an example here and the pile doesn't have one. Give me one now or we cut this section."
|
||||||
|
|
||||||
## Format arguments to actually have
|
## Format arguments to actually have
|
||||||
|
|
||||||
When choosing how to render a block, weigh these tradeoffs out loud with the user, not silently:
|
When choosing how to render a block, weigh these tradeoffs out loud with the user, not silently:
|
||||||
|
|
||||||
- **Prose vs. list.** Prose carries argument; lists carry parallel items. If items aren't truly parallel, prose is better. If they are, a list is faster to scan.
|
- **Prose vs. list.** Prose carries argument; lists carry parallel items. If items aren't truly parallel, prose is better. If they are, a list is faster to scan.
|
||||||
- **Inline vs. callout.** Tips, warnings, and asides go in callouts (`> [!TIP]`, `> [!NOTE]`) — but only if they'd genuinely derail the main argument inline. Otherwise leave them inline.
|
- **Inline vs. callout.** Tips, warnings, and asides go in callouts (`> [!TIP]`, `> [!NOTE]`), but only if they'd genuinely derail the main argument inline. Otherwise leave them inline.
|
||||||
- **Table vs. repeated structure.** If the same shape repeats 3+ times with the same fields, a table. Otherwise prose with bold leads.
|
- **Table vs. repeated structure.** If the same shape repeats 3+ times with the same fields, a table. Otherwise prose with bold leads.
|
||||||
- **Quote vs. paraphrase.** Quote when the original wording is the point. Paraphrase when only the idea matters.
|
- **Quote vs. paraphrase.** Quote when the original wording is the point. Paraphrase when only the idea matters.
|
||||||
- **Code block vs. inline code.** Multi-line, runnable, or illustrative → block. Single token or identifier → inline.
|
- **Code block vs. inline code.** Multi-line, runnable, or illustrative → block. Single token or identifier → inline.
|
||||||
|
|
||||||
## Writing rhythm
|
## Writing rhythm
|
||||||
|
|
||||||
Append to the article file as each block is agreed. Re-read the file from disk before every write — the user may have edited between turns. Never overwrite blindly. If the user wants a paragraph rewritten, edit that specific paragraph in place; leave the rest alone.
|
Append to the article file as each block is agreed. Re-read the file from disk before every write: the user may have edited between turns. Never overwrite blindly. If the user wants a paragraph rewritten, edit that specific paragraph in place; leave the rest alone.
|
||||||
|
|
||||||
## Out of scope
|
## Out of scope
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@
|
|||||||
# prefix byte is the shift variant (\x02N == prefix+shift+n).
|
# prefix byte is the shift variant (\x02N == prefix+shift+n).
|
||||||
|
|
||||||
# ── base / appearance ──
|
# ── base / appearance ──
|
||||||
font_size 13
|
font_size 11.5
|
||||||
font_family VictorMono Nerd Font
|
font_family VictorMono Nerd Font
|
||||||
bold_italic_font auto
|
bold_italic_font auto
|
||||||
window_padding_width 8
|
window_padding_width 8
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
# ── base.conf · shared ──
|
# ── base.conf · shared ──
|
||||||
font_size 13
|
font_size 11.5
|
||||||
font_family VictorMono Nerd Font
|
font_family VictorMono Nerd Font
|
||||||
bold_italic_font auto
|
bold_italic_font auto
|
||||||
window_padding_width 8
|
window_padding_width 8
|
||||||
@@ -26,11 +26,11 @@ action_alias launch_mn launch --cwd=current --type=overlay-main
|
|||||||
action_alias launch_os launch --cwd=current --type=os-window
|
action_alias launch_os launch --cwd=current --type=os-window
|
||||||
action_alias launch_ov launch --cwd=current --type=overlay
|
action_alias launch_ov launch --cwd=current --type=overlay
|
||||||
action_alias launch_tb launch --cwd=current --type=tab
|
action_alias launch_tb launch --cwd=current --type=tab
|
||||||
action_alias launch_hs launch --cwd=current --location=hsplit --bias=20
|
action_alias launch_hs launch --cwd=current --location=hsplit --bias=30
|
||||||
action_alias launch_vs launch --cwd=current --location=vsplit --bias=40
|
action_alias launch_vs launch --cwd=current --location=vsplit --bias=40
|
||||||
|
|
||||||
# panes = kitty windows
|
# panes = kitty windows
|
||||||
map super+t new_tab_with_cwd
|
map ctrl+shift+t new_tab_with_cwd
|
||||||
map super+enter launch_vs
|
map super+enter launch_vs
|
||||||
map ctrl+space launch_hs
|
map ctrl+space launch_hs
|
||||||
map ctrl+enter launch_vs
|
map ctrl+enter launch_vs
|
||||||
@@ -49,11 +49,13 @@ map ctrl+shift+f toggle_layout stack
|
|||||||
map super+z toggle_layout stack
|
map super+z toggle_layout stack
|
||||||
map ctrl+shift+e launch_tb nvim
|
map ctrl+shift+e launch_tb nvim
|
||||||
# herdr host: a *separate* kitty process, own config (launch cannot take --config)
|
# herdr host: a *separate* kitty process, own config (launch cannot take --config)
|
||||||
map ctrl+shift+a launch --type=background --cwd=current kitty --class=kitty-herdr --config ~/.config/kitty/herdr.conf
|
|
||||||
# tmux host: same trick — kitty stays dumb, tmux owns panes/windows/sessions
|
# tmux host: same trick — kitty stays dumb, tmux owns panes/windows/sessions
|
||||||
map ctrl+shift+t launch --type=background --cwd=current kitty --class=kitty-tmux --config ~/.config/kitty/tmux.conf
|
|
||||||
map ctrl+shift+p launch_hs atuin-pick
|
map ctrl+shift+p launch_hs atuin-pick
|
||||||
|
|
||||||
|
# Spawn
|
||||||
|
map super+t launch --type=background --cwd=current kitty --class=kitty-tmux --config ~/.config/kitty/tmux.conf
|
||||||
|
map super+a launch --type=background --cwd=current kitty --class=kitty-herdr --config ~/.config/kitty/herdr.conf
|
||||||
|
|
||||||
# Misc
|
# Misc
|
||||||
map ctrl+shift+c copy_to_clipboard
|
map ctrl+shift+c copy_to_clipboard
|
||||||
map ctrl+shift+v paste_from_clipboard
|
map ctrl+shift+v paste_from_clipboard
|
||||||
|
|||||||
@@ -7,7 +7,7 @@
|
|||||||
# Launched from the default config with ctrl+shift+t.
|
# Launched from the default config with ctrl+shift+t.
|
||||||
|
|
||||||
# ── base / appearance (kitty.conf parity) ──
|
# ── base / appearance (kitty.conf parity) ──
|
||||||
font_size 13
|
font_size 11.5
|
||||||
font_family VictorMono Nerd Font
|
font_family VictorMono Nerd Font
|
||||||
bold_italic_font auto
|
bold_italic_font auto
|
||||||
window_padding_width 8
|
window_padding_width 8
|
||||||
|
|||||||
+26
-25
@@ -3,18 +3,18 @@ text/plain=vim.desktop
|
|||||||
text/x-shellscript=vim.desktop
|
text/x-shellscript=vim.desktop
|
||||||
text/x-python=vim.desktop
|
text/x-python=vim.desktop
|
||||||
text/x-script.python=vim.desktop
|
text/x-script.python=vim.desktop
|
||||||
text/html=brave-origin-nightly.desktop
|
text/html=zen.desktop
|
||||||
x-scheme-handler/http=brave-origin-nightly.desktop
|
x-scheme-handler/http=zen.desktop
|
||||||
x-scheme-handler/https=brave-origin-nightly.desktop
|
x-scheme-handler/https=zen.desktop
|
||||||
x-scheme-handler/about=chromium.desktop
|
x-scheme-handler/about=zen.desktop
|
||||||
x-scheme-handler/unknown=chromium.desktop
|
x-scheme-handler/unknown=zen.desktop
|
||||||
x-scheme-handler/chrome=brave-origin-nightly.desktop
|
x-scheme-handler/chrome=zen.desktop
|
||||||
application/x-extension-htm=brave-origin-nightly.desktop
|
application/x-extension-htm=zen.desktop
|
||||||
application/x-extension-html=brave-origin-nightly.desktop
|
application/x-extension-html=zen.desktop
|
||||||
application/x-extension-shtml=brave-origin-nightly.desktop
|
application/x-extension-shtml=zen.desktop
|
||||||
application/xhtml+xml=brave-origin-nightly.desktop
|
application/xhtml+xml=zen.desktop
|
||||||
application/x-extension-xhtml=brave-origin-nightly.desktop
|
application/x-extension-xhtml=zen.desktop
|
||||||
application/x-extension-xht=brave-origin-nightly.desktop
|
application/x-extension-xht=zen.desktop
|
||||||
x-scheme-handler/figma=figma-linux.desktop
|
x-scheme-handler/figma=figma-linux.desktop
|
||||||
x-scheme-handler/claude=com.anthropic.Claude.desktop
|
x-scheme-handler/claude=com.anthropic.Claude.desktop
|
||||||
x-scheme-handler/claude-cli=claude-code-url-handler.desktop
|
x-scheme-handler/claude-cli=claude-code-url-handler.desktop
|
||||||
@@ -23,29 +23,30 @@ x-scheme-handler/todoist=todoist.desktop
|
|||||||
x-scheme-handler/openhuman=OpenHuman-handler.desktop
|
x-scheme-handler/openhuman=OpenHuman-handler.desktop
|
||||||
application/vnd.microsoft.portable-executable=wine.desktop
|
application/vnd.microsoft.portable-executable=wine.desktop
|
||||||
x-scheme-handler/slack=slack.desktop
|
x-scheme-handler/slack=slack.desktop
|
||||||
x-scheme-handler/mailto=userapp-Evolution-PCEYQ3.desktop
|
x-scheme-handler/mailto=userapp-Evolution-PCEYQ4.desktop
|
||||||
x-scheme-handler/anytype=anytype.desktop
|
x-scheme-handler/anytype=anytype.desktop
|
||||||
x-scheme-handler/piebald=piebald-handler.desktop
|
x-scheme-handler/piebald=piebald-handler.desktop
|
||||||
x-scheme-handler/discord-647066573147996161=discord-647066573147996161.desktop
|
x-scheme-handler/discord-647066573147996160=discord-647066573147996161.desktop
|
||||||
x-scheme-handler/tolaria=tolaria-handler.desktop
|
x-scheme-handler/tolaria=tolaria-handler.desktop
|
||||||
x-scheme-handler/antigravity=antigravity.desktop
|
x-scheme-handler/antigravity=antigravity.desktop
|
||||||
application/pdf=com.brave.Origin.nightly.desktop
|
application/pdf=com.brave.Origin.nightly.desktop
|
||||||
x-scheme-handler/opencode=ai.opencode.desktop.desktop
|
x-scheme-handler/opencode=ai.opencode.desktop.desktop
|
||||||
x-scheme-handler/follow=folo.desktop
|
x-scheme-handler/follow=folo.desktop
|
||||||
x-scheme-handler/folo=folo.desktop
|
x-scheme-handler/folo=folo.desktop
|
||||||
|
x-scheme-handler/tldraw-offline=tldraw-offline.desktop
|
||||||
|
|
||||||
[Added Associations]
|
[Added Associations]
|
||||||
x-scheme-handler/http=brave-origin-nightly.desktop;userapp-Floorp-9MTFP3.desktop;
|
x-scheme-handler/http=zen.desktop;brave-origin-nightly.desktop;userapp-Floorp-8MTFP3.desktop;
|
||||||
x-scheme-handler/https=brave-origin-nightly.desktop;userapp-Floorp-9MTFP3.desktop;
|
x-scheme-handler/https=zen.desktop;brave-origin-nightly.desktop;userapp-Floorp-8MTFP3.desktop;
|
||||||
x-scheme-handler/chrome=brave-origin-nightly.desktop;userapp-Floorp-9MTFP3.desktop;
|
x-scheme-handler/chrome=zen.desktop;brave-origin-nightly.desktop;userapp-Floorp-8MTFP3.desktop;
|
||||||
text/html=brave-origin-nightly.desktop;userapp-Floorp-9MTFP3.desktop;
|
text/html=zen.desktop;brave-origin-nightly.desktop;userapp-Floorp-8MTFP3.desktop;
|
||||||
application/x-extension-htm=brave-origin-nightly.desktop;userapp-Floorp-9MTFP3.desktop;
|
application/x-extension-htm=zen.desktop;brave-origin-nightly.desktop;userapp-Floorp-8MTFP3.desktop;
|
||||||
application/x-extension-html=brave-origin-nightly.desktop;userapp-Floorp-9MTFP3.desktop;
|
application/x-extension-html=zen.desktop;brave-origin-nightly.desktop;userapp-Floorp-8MTFP3.desktop;
|
||||||
application/x-extension-shtml=brave-origin-nightly.desktop;userapp-Floorp-9MTFP3.desktop;
|
application/x-extension-shtml=zen.desktop;brave-origin-nightly.desktop;userapp-Floorp-8MTFP3.desktop;
|
||||||
application/xhtml+xml=brave-origin-nightly.desktop;userapp-Floorp-9MTFP3.desktop;
|
application/xhtml+xml=zen.desktop;brave-origin-nightly.desktop;userapp-Floorp-8MTFP3.desktop;
|
||||||
application/x-extension-xhtml=brave-origin-nightly.desktop;userapp-Floorp-9MTFP3.desktop;
|
application/x-extension-xhtml=zen.desktop;brave-origin-nightly.desktop;userapp-Floorp-8MTFP3.desktop;
|
||||||
application/x-extension-xht=brave-origin-nightly.desktop;userapp-Floorp-9MTFP3.desktop;
|
application/x-extension-xht=zen.desktop;brave-origin-nightly.desktop;userapp-Floorp-8MTFP3.desktop;
|
||||||
application/vnd.microsoft.portable-executable=wine.desktop;
|
application/vnd.microsoft.portable-executable=wine.desktop;
|
||||||
x-scheme-handler/mailto=userapp-Evolution-PCEYQ3.desktop;
|
x-scheme-handler/mailto=userapp-Evolution-PCEYQ4.desktop;
|
||||||
application/pdf=com.brave.Origin.nightly.desktop;
|
application/pdf=com.brave.Origin.nightly.desktop;
|
||||||
x-scheme-handler/opencode=ai.opencode.desktop.desktop;
|
x-scheme-handler/opencode=ai.opencode.desktop.desktop;
|
||||||
@@ -81,31 +81,15 @@ window-rule {
|
|||||||
opacity 1.0
|
opacity 1.0
|
||||||
|
|
||||||
// default-floating-position x=28 y=28 relative-to="top-right"
|
// default-floating-position x=28 y=28 relative-to="top-right"
|
||||||
default-floating-position x=28 y=28 relative-to="bottom-left"
|
default-floating-position x=24 y=24 relative-to="top-right"
|
||||||
// open-on-output "eDP-1"
|
open-on-output "eDP-1"
|
||||||
open-on-output "HDMI-A-1"
|
// open-on-output "HDMI-A-1"
|
||||||
// open-on-output "Apple Computer Inc StudioDisplay 0x984262A7"
|
// open-on-output "Apple Computer Inc StudioDisplay 0x984262A7"
|
||||||
}
|
}
|
||||||
|
|
||||||
window-rule {
|
|
||||||
// open-on-output "HDMI-A-1"
|
|
||||||
}
|
|
||||||
|
|
||||||
window-rule {
|
window-rule {
|
||||||
match app-id="zed"
|
match app-id="zed"
|
||||||
match app-id="obsidian"
|
match app-id="obsidian"
|
||||||
match app-id="gemini-desktop"
|
|
||||||
match app-id="com-fastmail-fastmail"
|
|
||||||
match app-id="Beeper"
|
|
||||||
match app-id="todoist"
|
|
||||||
match app-id="com.anthropic.Claude"
|
|
||||||
match app-id="Hermes"
|
|
||||||
match app-id="chromium"
|
|
||||||
|
|
||||||
open-on-output "Apple Computer Inc StudioDisplay 0x984262A7"
|
|
||||||
}
|
|
||||||
|
|
||||||
window-rule {
|
|
||||||
match app-id="sticky-notest-canvas"
|
match app-id="sticky-notest-canvas"
|
||||||
match title="Sticky Notes"
|
match title="Sticky Notes"
|
||||||
match app-id="vacuumtube"
|
match app-id="vacuumtube"
|
||||||
@@ -114,6 +98,6 @@ window-rule {
|
|||||||
match app-id="kitty-herdr"
|
match app-id="kitty-herdr"
|
||||||
match app-id="kitty-tmux"
|
match app-id="kitty-tmux"
|
||||||
|
|
||||||
open-on-output "eDP-1"
|
open-on-output "Apple Computer Inc StudioDisplay 0x984262A7"
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -21,9 +21,46 @@ workspace "1" {
|
|||||||
}
|
}
|
||||||
|
|
||||||
window-rule {
|
window-rule {
|
||||||
match app-id="org.gnome.Calendar"
|
match app-id="chrome-youtube.com__-Default"
|
||||||
match app-id="discord"
|
match app-id="chromium"
|
||||||
match app-id="slack"
|
|
||||||
|
draw-border-with-background false
|
||||||
|
|
||||||
|
open-focused true
|
||||||
|
open-maximized true
|
||||||
|
open-on-workspace "1"
|
||||||
|
}
|
||||||
|
|
||||||
|
workspace "2" {
|
||||||
|
open-on-output "Tianma Microelectronics Ltd. TL134ADXP03 Unknown"
|
||||||
|
}
|
||||||
|
|
||||||
|
window-rule {
|
||||||
|
match app-id="org.gnome.Calendar"
|
||||||
|
match app-id="discord"
|
||||||
|
match app-id="slack"
|
||||||
|
match app-id="com-fastmail-fastmail"
|
||||||
|
match app-id="gemini-desktop"
|
||||||
|
match app-id="Beeper"
|
||||||
|
match app-id="com.anthropic.Claude"
|
||||||
|
match app-id="Hermes"
|
||||||
|
match app-id="todoist"
|
||||||
|
|
||||||
|
draw-border-with-background false
|
||||||
|
|
||||||
|
open-focused true
|
||||||
|
open-maximized true
|
||||||
|
open-on-workspace "1"
|
||||||
|
}
|
||||||
|
|
||||||
|
workspace "3" {
|
||||||
|
open-on-output "Tianma Microelectronics Ltd. TL134ADXP03 Unknown"
|
||||||
|
}
|
||||||
|
|
||||||
|
window-rule {
|
||||||
|
match app-id="WebApp-CloudflarePersonal7594"
|
||||||
|
match app-id="WebApp-CloudflareWalletbase8881"
|
||||||
|
|
||||||
draw-border-with-background false
|
draw-border-with-background false
|
||||||
|
|
||||||
open-focused true
|
open-focused true
|
||||||
|
|||||||
@@ -20,3 +20,10 @@ require("bunny"):setup({
|
|||||||
notify = false, -- Notify after hopping, default is false
|
notify = false, -- Notify after hopping, default is false
|
||||||
fuzzy_cmd = "fzf", -- Fuzzy searching command, default is "fzf"
|
fuzzy_cmd = "fzf", -- Fuzzy searching command, default is "fzf"
|
||||||
})
|
})
|
||||||
|
|
||||||
|
require("git"):setup {
|
||||||
|
-- Order of status signs showing in the linemode
|
||||||
|
order = 1500,
|
||||||
|
}
|
||||||
|
|
||||||
|
require("no-status"):setup()
|
||||||
@@ -1,5 +1,5 @@
|
|||||||
[[mgr.prepend_keymap]]
|
[[mgr.prepend_keymap]]
|
||||||
on = "f"
|
on = "F"
|
||||||
run = "plugin smart-filter"
|
run = "plugin smart-filter"
|
||||||
desc = "Smart filter"
|
desc = "Smart filter"
|
||||||
|
|
||||||
@@ -147,4 +147,4 @@ desc = "Create a directory"
|
|||||||
[[mgr.prepend_keymap]]
|
[[mgr.prepend_keymap]]
|
||||||
on = "N"
|
on = "N"
|
||||||
run = "bulk_create"
|
run = "bulk_create"
|
||||||
desc = "Bulk create files"
|
desc = "Bulk create files"
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
[[plugin.deps]]
|
[[plugin.deps]]
|
||||||
use = "yazi-rs/plugins:smart-filter"
|
use = "yazi-rs/plugins:smart-filter"
|
||||||
rev = "3f2b882"
|
rev = "efa4d79"
|
||||||
hash = "d6f7351ea25a43c9b5f4315fa1e23935"
|
hash = "d6f7351ea25a43c9b5f4315fa1e23935"
|
||||||
|
|
||||||
[[plugin.deps]]
|
[[plugin.deps]]
|
||||||
@@ -10,22 +10,22 @@ hash = "8c1b36103121a66b37308afaf7124575"
|
|||||||
|
|
||||||
[[plugin.deps]]
|
[[plugin.deps]]
|
||||||
use = "yazi-rs/plugins:smart-enter"
|
use = "yazi-rs/plugins:smart-enter"
|
||||||
rev = "3f2b882"
|
rev = "efa4d79"
|
||||||
hash = "187cc58ba7ac3befd49c342129e6f1b6"
|
hash = "187cc58ba7ac3befd49c342129e6f1b6"
|
||||||
|
|
||||||
[[plugin.deps]]
|
[[plugin.deps]]
|
||||||
use = "yazi-rs/plugins:piper"
|
use = "yazi-rs/plugins:piper"
|
||||||
rev = "3f2b882"
|
rev = "efa4d79"
|
||||||
hash = "f23ecc89ce0f9eeefdd4cea14e2a9ba7"
|
hash = "45a533508a9840cc5a10cf6129f63e6a"
|
||||||
|
|
||||||
[[plugin.deps]]
|
[[plugin.deps]]
|
||||||
use = "Rolv-Apneseth/starship"
|
use = "Rolv-Apneseth/starship"
|
||||||
rev = "159eaba"
|
rev = "ea92cf4"
|
||||||
hash = "7de446280b1ba8c49ffd86dbc24bbbe6"
|
hash = "9776f378459072b6c2875eae5addc49d"
|
||||||
|
|
||||||
[[plugin.deps]]
|
[[plugin.deps]]
|
||||||
use = "mikavilpas/easyjump.yazi:easyjump"
|
use = "mikavilpas/easyjump.yazi:easyjump"
|
||||||
rev = "da7e2d1"
|
rev = "4aa1a06"
|
||||||
hash = "49625b69287597c3b8093c9f1a2f7241"
|
hash = "49625b69287597c3b8093c9f1a2f7241"
|
||||||
|
|
||||||
[[plugin.deps]]
|
[[plugin.deps]]
|
||||||
@@ -48,5 +48,20 @@ use = "WhoSowSee/mdv-previewer"
|
|||||||
rev = "ea4732b"
|
rev = "ea4732b"
|
||||||
hash = "fb830053557fbb323c609cb97099a8aa"
|
hash = "fb830053557fbb323c609cb97099a8aa"
|
||||||
|
|
||||||
|
[[plugin.deps]]
|
||||||
|
use = "yazi-rs/plugins:vcs-files"
|
||||||
|
rev = "efa4d79"
|
||||||
|
hash = "853240b2454c93a93fd03fc9fd7e06e8"
|
||||||
|
|
||||||
|
[[plugin.deps]]
|
||||||
|
use = "yazi-rs/plugins:git"
|
||||||
|
rev = "efa4d79"
|
||||||
|
hash = "5bb0bfab901d3601c370eafdd66edd31"
|
||||||
|
|
||||||
|
[[plugin.deps]]
|
||||||
|
use = "yazi-rs/plugins:no-status"
|
||||||
|
rev = "efa4d79"
|
||||||
|
hash = "3e023d31f29201efdac2a6ae35fedb78"
|
||||||
|
|
||||||
[flavor]
|
[flavor]
|
||||||
deps = []
|
deps = []
|
||||||
@@ -54,9 +54,9 @@ elif [[ "$APP" == "ghostty" ]]; then
|
|||||||
# Cycle through Ghostty terminals (case-insensitive app_id match)
|
# Cycle through Ghostty terminals (case-insensitive app_id match)
|
||||||
INSTANCES=($(niri msg -j windows | jq -r '.[] | select(.app_id | test("ghostty"; "i")) | .id'))
|
INSTANCES=($(niri msg -j windows | jq -r '.[] | select(.app_id | test("ghostty"; "i")) | .id'))
|
||||||
elif [[ "$APP" == "browser" ]]; then
|
elif [[ "$APP" == "browser" ]]; then
|
||||||
# Cycle through all browsers (brave/chromium/firefox) + Claude desktop, launch default if none
|
# Cycle through all browsers (zen/brave/chromium/firefox), launch default if none
|
||||||
INSTANCES=($(niri msg -j windows | jq -r '.[] | select((.app_id // "") | ascii_downcase | test("^(brave|chromium|firefox)")) | .id'))
|
INSTANCES=($(niri msg -j windows | jq -r '.[] | select((.app_id // "") | ascii_downcase | test("^(zen|brave|chromium|firefox)")) | .id'))
|
||||||
DEFAULT_SPAWN="brave-origin-nightly"
|
DEFAULT_SPAWN="zen"
|
||||||
elif [[ "$APP" == "terminal" ]]; then
|
elif [[ "$APP" == "terminal" ]]; then
|
||||||
# Cycle through all terminals (ghostty/kitty/alacritty), launch default if none
|
# Cycle through all terminals (ghostty/kitty/alacritty), launch default if none
|
||||||
INSTANCES=($(niri msg -j windows | jq -r '.[] | select((.app_id // "") | ascii_downcase | test("kitty|alacritty|ghostty")) | .id'))
|
INSTANCES=($(niri msg -j windows | jq -r '.[] | select((.app_id // "") | ascii_downcase | test("kitty|alacritty|ghostty")) | .id'))
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
theme:
|
theme:
|
||||||
dark: cyberdream
|
dark: cyberdream
|
||||||
symbolPreset: nerd
|
symbolPreset: nerd
|
||||||
setupVersion: 1
|
setupVersion: 2
|
||||||
hideThinkingBlock: true
|
hideThinkingBlock: true
|
||||||
modelRoles:
|
modelRoles:
|
||||||
default: anthropic/claude-fable-5:high
|
default: anthropic/claude-fable-5:high
|
||||||
Reference in new issue
Block a user