ctxr-cli 0.5.0 → 0.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/adapter.d.ts +0 -1
- package/dist/adapter.d.ts.map +1 -1
- package/dist/adapter.js.map +1 -1
- package/dist/adapters/builtin/index.d.ts.map +1 -1
- package/dist/adapters/builtin/index.js +2 -2
- package/dist/adapters/builtin/index.js.map +1 -1
- package/dist/adapters/harness/claude-code.d.ts.map +1 -1
- package/dist/adapters/harness/claude-code.js +30 -14
- package/dist/adapters/harness/claude-code.js.map +1 -1
- package/dist/adapters/harness/hermes-agent.d.ts +9 -0
- package/dist/adapters/harness/hermes-agent.d.ts.map +1 -0
- package/dist/adapters/harness/hermes-agent.js +13 -0
- package/dist/adapters/harness/hermes-agent.js.map +1 -0
- package/dist/adapters/types.d.ts +38 -18
- package/dist/adapters/types.d.ts.map +1 -1
- package/dist/adapters/types.js +3 -3
- package/dist/adapters/types.js.map +1 -1
- package/dist/commands/adapters-generate.d.ts +4 -2
- package/dist/commands/adapters-generate.d.ts.map +1 -1
- package/dist/commands/adapters-generate.js +14 -6
- package/dist/commands/adapters-generate.js.map +1 -1
- package/dist/commands/archive.d.ts +6 -4
- package/dist/commands/archive.d.ts.map +1 -1
- package/dist/commands/archive.js +7 -5
- package/dist/commands/archive.js.map +1 -1
- package/dist/commands/catalog-show.d.ts +0 -1
- package/dist/commands/catalog-show.d.ts.map +1 -1
- package/dist/commands/catalog-show.js +1 -1
- package/dist/commands/catalog-show.js.map +1 -1
- package/dist/commands/graph-query.d.ts +2 -11
- package/dist/commands/graph-query.d.ts.map +1 -1
- package/dist/commands/graph-query.js +11 -14
- package/dist/commands/graph-query.js.map +1 -1
- package/dist/commands/init.d.ts +2 -0
- package/dist/commands/init.d.ts.map +1 -1
- package/dist/commands/init.js +82 -21
- package/dist/commands/init.js.map +1 -1
- package/dist/commands/publish-check.d.ts +23 -0
- package/dist/commands/publish-check.d.ts.map +1 -0
- package/dist/commands/publish-check.js +112 -0
- package/dist/commands/publish-check.js.map +1 -0
- package/dist/commands/publish-gather.d.ts +27 -0
- package/dist/commands/publish-gather.d.ts.map +1 -0
- package/dist/commands/publish-gather.js +73 -0
- package/dist/commands/publish-gather.js.map +1 -0
- package/dist/commands/publish-new.d.ts +19 -0
- package/dist/commands/publish-new.d.ts.map +1 -0
- package/dist/commands/publish-new.js +108 -0
- package/dist/commands/publish-new.js.map +1 -0
- package/dist/commands/serve.d.ts +32 -0
- package/dist/commands/serve.d.ts.map +1 -0
- package/dist/commands/serve.js +151 -0
- package/dist/commands/serve.js.map +1 -0
- package/dist/commands/session-capture.d.ts.map +1 -1
- package/dist/commands/session-capture.js +0 -2
- package/dist/commands/session-capture.js.map +1 -1
- package/dist/commands/update.js +3 -3
- package/dist/commands/update.js.map +1 -1
- package/dist/config/defaults.d.ts +49 -44
- package/dist/config/defaults.d.ts.map +1 -1
- package/dist/config/defaults.js +49 -47
- package/dist/config/defaults.js.map +1 -1
- package/dist/config/schema.d.ts +53 -52
- package/dist/config/schema.d.ts.map +1 -1
- package/dist/config/schema.js +84 -62
- package/dist/config/schema.js.map +1 -1
- package/dist/core/agents-doc.d.ts +9 -0
- package/dist/core/agents-doc.d.ts.map +1 -1
- package/dist/core/agents-doc.js +31 -16
- package/dist/core/agents-doc.js.map +1 -1
- package/dist/core/browse/link-resolver.d.ts +12 -0
- package/dist/core/browse/link-resolver.d.ts.map +1 -0
- package/dist/core/browse/link-resolver.js +12 -0
- package/dist/core/browse/link-resolver.js.map +1 -0
- package/dist/core/browse/nav.d.ts +10 -0
- package/dist/core/browse/nav.d.ts.map +1 -0
- package/dist/core/browse/nav.js +101 -0
- package/dist/core/browse/nav.js.map +1 -0
- package/dist/core/browse/render.d.ts +5 -0
- package/dist/core/browse/render.d.ts.map +1 -0
- package/dist/core/browse/render.js +66 -0
- package/dist/core/browse/render.js.map +1 -0
- package/dist/core/browse/routes.d.ts +40 -0
- package/dist/core/browse/routes.d.ts.map +1 -0
- package/dist/core/browse/routes.js +68 -0
- package/dist/core/browse/routes.js.map +1 -0
- package/dist/core/browse/templates.d.ts +13 -0
- package/dist/core/browse/templates.d.ts.map +1 -0
- package/dist/core/browse/templates.js +39 -0
- package/dist/core/browse/templates.js.map +1 -0
- package/dist/core/browse/tree.d.ts +33 -0
- package/dist/core/browse/tree.d.ts.map +1 -0
- package/dist/core/browse/tree.js +53 -0
- package/dist/core/browse/tree.js.map +1 -0
- package/dist/core/catalog/build.d.ts +1 -1
- package/dist/core/catalog/build.d.ts.map +1 -1
- package/dist/core/catalog/build.js +1 -2
- package/dist/core/catalog/build.js.map +1 -1
- package/dist/core/catalog/model.d.ts +2 -0
- package/dist/core/catalog/model.d.ts.map +1 -1
- package/dist/core/catalog/model.js +2 -1
- package/dist/core/catalog/model.js.map +1 -1
- package/dist/core/checks/integrity-checks.d.ts +18 -2
- package/dist/core/checks/integrity-checks.d.ts.map +1 -1
- package/dist/core/checks/integrity-checks.js +55 -10
- package/dist/core/checks/integrity-checks.js.map +1 -1
- package/dist/core/checks/manifest.d.ts.map +1 -1
- package/dist/core/checks/manifest.js +0 -5
- package/dist/core/checks/manifest.js.map +1 -1
- package/dist/core/checks/organize-checks.d.ts +10 -3
- package/dist/core/checks/organize-checks.d.ts.map +1 -1
- package/dist/core/checks/organize-checks.js +14 -5
- package/dist/core/checks/organize-checks.js.map +1 -1
- package/dist/core/checks/types.d.ts +1 -1
- package/dist/core/convention-doc.d.ts +21 -19
- package/dist/core/convention-doc.d.ts.map +1 -1
- package/dist/core/convention-doc.js +48 -62
- package/dist/core/convention-doc.js.map +1 -1
- package/dist/core/conventions.d.ts +2 -2
- package/dist/core/conventions.js +2 -2
- package/dist/core/errors.d.ts +31 -44
- package/dist/core/errors.d.ts.map +1 -1
- package/dist/core/errors.js +81 -128
- package/dist/core/errors.js.map +1 -1
- package/dist/core/exit-codes.d.ts +7 -5
- package/dist/core/exit-codes.d.ts.map +1 -1
- package/dist/core/exit-codes.js +7 -5
- package/dist/core/exit-codes.js.map +1 -1
- package/dist/core/git/repo.d.ts +0 -6
- package/dist/core/git/repo.d.ts.map +1 -1
- package/dist/core/git/repo.js +0 -13
- package/dist/core/git/repo.js.map +1 -1
- package/dist/core/git/worktree.d.ts +4 -7
- package/dist/core/git/worktree.d.ts.map +1 -1
- package/dist/core/git/worktree.js +4 -10
- package/dist/core/git/worktree.js.map +1 -1
- package/dist/core/graph/model.d.ts +14 -0
- package/dist/core/graph/model.d.ts.map +1 -1
- package/dist/core/graph/model.js +30 -14
- package/dist/core/graph/model.js.map +1 -1
- package/dist/core/harness/bridge.d.ts +30 -0
- package/dist/core/harness/bridge.d.ts.map +1 -0
- package/dist/core/harness/bridge.js +178 -0
- package/dist/core/harness/bridge.js.map +1 -0
- package/dist/core/ingest/identity.d.ts +4 -4
- package/dist/core/ingest/identity.js +4 -4
- package/dist/core/json-config-merge.d.ts.map +1 -1
- package/dist/core/json-config-merge.js +30 -7
- package/dist/core/json-config-merge.js.map +1 -1
- package/dist/core/migrations/add-explanation-craft-skill.d.ts +26 -0
- package/dist/core/migrations/add-explanation-craft-skill.d.ts.map +1 -0
- package/dist/core/migrations/add-explanation-craft-skill.js +94 -0
- package/dist/core/migrations/add-explanation-craft-skill.js.map +1 -0
- package/dist/core/migrations/archive-destination-from-taxonomy.d.ts +35 -0
- package/dist/core/migrations/archive-destination-from-taxonomy.d.ts.map +1 -0
- package/dist/core/migrations/archive-destination-from-taxonomy.js +109 -0
- package/dist/core/migrations/archive-destination-from-taxonomy.js.map +1 -0
- package/dist/core/migrations/drop-access-axes.d.ts +24 -0
- package/dist/core/migrations/drop-access-axes.d.ts.map +1 -0
- package/dist/core/migrations/drop-access-axes.js +54 -0
- package/dist/core/migrations/drop-access-axes.js.map +1 -0
- package/dist/core/migrations/drop-forge-and-workspaces-external.d.ts +19 -0
- package/dist/core/migrations/drop-forge-and-workspaces-external.d.ts.map +1 -0
- package/dist/core/migrations/drop-forge-and-workspaces-external.js +49 -0
- package/dist/core/migrations/drop-forge-and-workspaces-external.js.map +1 -0
- package/dist/core/migrations/registry.d.ts +11 -1
- package/dist/core/migrations/registry.d.ts.map +1 -1
- package/dist/core/migrations/registry.js +19 -3
- package/dist/core/migrations/registry.js.map +1 -1
- package/dist/core/notes/list.d.ts +1 -12
- package/dist/core/notes/list.d.ts.map +1 -1
- package/dist/core/notes/list.js +5 -1
- package/dist/core/notes/list.js.map +1 -1
- package/dist/core/publish/script-check.d.ts +12 -0
- package/dist/core/publish/script-check.d.ts.map +1 -0
- package/dist/core/publish/script-check.js +39 -0
- package/dist/core/publish/script-check.js.map +1 -0
- package/dist/core/reconcile.d.ts +3 -0
- package/dist/core/reconcile.d.ts.map +1 -1
- package/dist/core/reconcile.js +15 -5
- package/dist/core/reconcile.js.map +1 -1
- package/dist/core/records.d.ts +4 -5
- package/dist/core/records.d.ts.map +1 -1
- package/dist/core/records.js +0 -2
- package/dist/core/records.js.map +1 -1
- package/dist/core/session.d.ts +9 -9
- package/dist/core/session.js +9 -9
- package/dist/core/skills.d.ts +42 -0
- package/dist/core/skills.d.ts.map +1 -1
- package/dist/core/skills.js +159 -31
- package/dist/core/skills.js.map +1 -1
- package/dist/core/write-lifecycle/path-gate.d.ts.map +1 -1
- package/dist/core/write-lifecycle/path-gate.js +4 -2
- package/dist/core/write-lifecycle/path-gate.js.map +1 -1
- package/dist/prompt/inquirer-prompter.d.ts.map +1 -1
- package/dist/prompt/inquirer-prompter.js +11 -1
- package/dist/prompt/inquirer-prompter.js.map +1 -1
- package/dist/prompt/prompter.d.ts +16 -0
- package/dist/prompt/prompter.d.ts.map +1 -1
- package/dist/run.d.ts.map +1 -1
- package/dist/run.js +69 -101
- package/dist/run.js.map +1 -1
- package/dist/taxonomy/profiles.d.ts +11 -0
- package/dist/taxonomy/profiles.d.ts.map +1 -1
- package/dist/taxonomy/profiles.js +1 -0
- package/dist/taxonomy/profiles.js.map +1 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +3 -1
- package/templates/agents/canonical.md +1 -3
- package/templates/conventions/baseline-conventions.md +27 -0
- package/templates/conventions/{custom-convention-seed.md → house-conventions-seed.md} +15 -2
- package/templates/hooks/pre-push.sh +1 -1
- package/templates/serve/shell.html +18 -0
- package/templates/serve/style.css +163 -0
- package/templates/skills/ctxr-land.md +32 -18
- package/templates/skills/ctxr-organize-audit.md +2 -10
- package/templates/skills/ctxr-placement.md +6 -24
- package/templates/skills/ctxr-publish.md +84 -0
- package/templates/skills/ctxr-session-capture.md +43 -3
- package/templates/skills/ctxr-session-lifecycle.md +20 -1
- package/templates/skills/ctxr-submit.md +15 -11
- package/templates/vendor/eli5/LICENSE.txt +21 -0
- package/templates/vendor/eli5/SKILL.md +116 -0
- package/templates/vendor/eli5/provenance.json +8 -0
- package/templates/vendor/frontend-design/LICENSE.txt +177 -0
- package/templates/vendor/frontend-design/SKILL.md +55 -0
- package/templates/vendor/frontend-design/provenance.json +7 -0
- package/dist/adapters/forge/github.d.ts +0 -12
- package/dist/adapters/forge/github.d.ts.map +0 -1
- package/dist/adapters/forge/github.js +0 -76
- package/dist/adapters/forge/github.js.map +0 -1
- package/dist/adapters/forge/types.d.ts +0 -46
- package/dist/adapters/forge/types.d.ts.map +0 -1
- package/dist/adapters/forge/types.js +0 -2
- package/dist/adapters/forge/types.js.map +0 -1
- package/dist/commands/check.d.ts +0 -30
- package/dist/commands/check.d.ts.map +0 -1
- package/dist/commands/check.js +0 -70
- package/dist/commands/check.js.map +0 -1
- package/dist/commands/note-resolve.d.ts +0 -14
- package/dist/commands/note-resolve.d.ts.map +0 -1
- package/dist/commands/note-resolve.js +0 -24
- package/dist/commands/note-resolve.js.map +0 -1
- package/dist/commands/session-abandon.d.ts +0 -13
- package/dist/commands/session-abandon.d.ts.map +0 -1
- package/dist/commands/session-abandon.js +0 -22
- package/dist/commands/session-abandon.js.map +0 -1
- package/dist/commands/session-land.d.ts +0 -45
- package/dist/commands/session-land.d.ts.map +0 -1
- package/dist/commands/session-land.js +0 -171
- package/dist/commands/session-land.js.map +0 -1
- package/dist/commands/session-reap.d.ts +0 -22
- package/dist/commands/session-reap.d.ts.map +0 -1
- package/dist/commands/session-reap.js +0 -52
- package/dist/commands/session-reap.js.map +0 -1
- package/dist/commands/session-submit.d.ts +0 -29
- package/dist/commands/session-submit.d.ts.map +0 -1
- package/dist/commands/session-submit.js +0 -72
- package/dist/commands/session-submit.js.map +0 -1
- package/dist/core/checks/disclosure-checks.d.ts +0 -4
- package/dist/core/checks/disclosure-checks.d.ts.map +0 -1
- package/dist/core/checks/disclosure-checks.js +0 -24
- package/dist/core/checks/disclosure-checks.js.map +0 -1
- package/dist/core/disclosure/leak-scan.d.ts +0 -19
- package/dist/core/disclosure/leak-scan.d.ts.map +0 -1
- package/dist/core/disclosure/leak-scan.js +0 -31
- package/dist/core/disclosure/leak-scan.js.map +0 -1
- package/dist/core/disclosure/model.d.ts +0 -18
- package/dist/core/disclosure/model.d.ts.map +0 -1
- package/dist/core/disclosure/model.js +0 -45
- package/dist/core/disclosure/model.js.map +0 -1
- package/dist/core/graph/visibility-filter.d.ts +0 -13
- package/dist/core/graph/visibility-filter.d.ts.map +0 -1
- package/dist/core/graph/visibility-filter.js +0 -26
- package/dist/core/graph/visibility-filter.js.map +0 -1
- package/dist/core/migrations/rename-visibility-field.d.ts +0 -3
- package/dist/core/migrations/rename-visibility-field.d.ts.map +0 -1
- package/dist/core/migrations/rename-visibility-field.js +0 -62
- package/dist/core/migrations/rename-visibility-field.js.map +0 -1
- package/dist/core/notes/checks.d.ts +0 -20
- package/dist/core/notes/checks.d.ts.map +0 -1
- package/dist/core/notes/checks.js +0 -58
- package/dist/core/notes/checks.js.map +0 -1
- package/dist/core/notes/visibility.d.ts +0 -26
- package/dist/core/notes/visibility.d.ts.map +0 -1
- package/dist/core/notes/visibility.js +0 -41
- package/dist/core/notes/visibility.js.map +0 -1
- package/templates/conventions/baseline-convention.md +0 -60
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
Turn store content into a shareable HTML page for a subject — a store subtree, a single note, a
|
|
2
|
+
concept whose sources aren't co-located, or everything a named context admits. The gate below is the
|
|
3
|
+
one step no convention can enforce by itself; everything else here is a decision procedure, not a
|
|
4
|
+
mechanism.
|
|
5
|
+
|
|
6
|
+
## 1. Does this earn a page over a note?
|
|
7
|
+
|
|
8
|
+
Reach for a page when the reader needs to compare options side by side, see spatial structure, manipulate
|
|
9
|
+
something, navigate non-linearly, or share a link — and the store's own notes genuinely can't. A page
|
|
10
|
+
costs several times the effort of the markdown it's drawn from; don't build one to restate a note in a
|
|
11
|
+
different font. If a note would do the job, the note is the deliverable.
|
|
12
|
+
|
|
13
|
+
## 2. Name the subject, let the selector produce the set
|
|
14
|
+
|
|
15
|
+
`ctxr publish gather` resolves a subject to its source notes — never a hand-picked list, which is how
|
|
16
|
+
an unintended note slips in unnoticed:
|
|
17
|
+
|
|
18
|
+
- `--under <prefix>` — a store subtree
|
|
19
|
+
- `--note <path>` — a single note
|
|
20
|
+
- `--entity <name>` — every note linking to a concept, the same enumeration `ctxr rollup gather` uses
|
|
21
|
+
|
|
22
|
+
## 3. Decide what belongs on the page
|
|
23
|
+
|
|
24
|
+
The store does not decide this for you. Read the resolved set and judge, note by note, whether its
|
|
25
|
+
content belongs in front of this page's intended readers — a page written for an outside party must
|
|
26
|
+
not carry material written about that party, or about anyone else who did not expect to be quoted.
|
|
27
|
+
When you are unsure about a note, leave it out and name it to the operator rather than guessing.
|
|
28
|
+
|
|
29
|
+
## 4. Fix the identity once
|
|
30
|
+
|
|
31
|
+
`ctxr publish new <slug>` creates the page's folder. A slug starting with a date (`YYYY-` or
|
|
32
|
+
`YYYY-MM-DD-`) is reserved for a frozen snapshot — never used for a page you intend to keep updating.
|
|
33
|
+
The command refuses to overwrite an existing folder; if one already exists for this subject, edit its
|
|
34
|
+
files directly rather than re-running `publish new` — a rename or an overwrite breaks any link already
|
|
35
|
+
handed out.
|
|
36
|
+
|
|
37
|
+
## 5. Choose the form, then delegate the craft
|
|
38
|
+
|
|
39
|
+
Pick the shape the content actually needs — a status board, a timeline, a side-by-side comparison, an
|
|
40
|
+
explainer with a live demo — not a rendering of the source notes in reading order. Contexture ships no
|
|
41
|
+
renderer of its own and no house voice: both halves of the craft are delegated to a skill.
|
|
42
|
+
|
|
43
|
+
**The form and its visual language.** Load the `frontend-design` skill this store carries by default
|
|
44
|
+
(or whichever design-focused skill it's configured or installed instead) and follow it for the HTML,
|
|
45
|
+
CSS, type, and palette — and for the interface's own words: labels, buttons, empty and error states.
|
|
46
|
+
If a sibling page already exists, read its stylesheet and inherit its palette and type scale before
|
|
47
|
+
inventing a new one.
|
|
48
|
+
|
|
49
|
+
**The prose that explains the subject.** A page is read by someone who wasn't in the sessions the
|
|
50
|
+
notes came from, so the notes' shorthand does not survive the copy out. Load the `eli5` skill this
|
|
51
|
+
store carries by default (or whichever explanation-focused skill it's configured instead), settle who
|
|
52
|
+
the reader is before writing, and pitch every definition, analogy, and level of detail at them.
|
|
53
|
+
|
|
54
|
+
Both skills say "audience", and neither means step 3's. There, `--audience` names who the store is
|
|
55
|
+
being asked to disclose to and the answer is a verdict; here it names how much a reader already knows
|
|
56
|
+
and the answer is a register. A comprehension level is never a value you pass to `--audience`, and
|
|
57
|
+
writing plainly never widens what the page may contain — the gate in step 3 already settled that.
|
|
58
|
+
|
|
59
|
+
## 6. Verify the output invariants
|
|
60
|
+
|
|
61
|
+
`ctxr publish check <path>` runs the mechanical half of the checklist — no external network address,
|
|
62
|
+
a viewport meta tag, at least one print rule, a provenance line, a sibling README, balanced tags, and
|
|
63
|
+
valid syntax in every embedded script. It exits non-zero naming every failing check; fix all of them
|
|
64
|
+
before reporting the page as ready. It answers only what's derivable from the file itself — the DO-test
|
|
65
|
+
in step 1, the form and reader choices in step 5, and factual accuracy stay judgment calls, not checker output.
|
|
66
|
+
|
|
67
|
+
## 7. It's a page, not a note
|
|
68
|
+
|
|
69
|
+
The published-pages location is excluded from retrieval by default — a page never becomes a source for
|
|
70
|
+
anything else the store retrieves. Confirm with `ctxr lint` after landing.
|
|
71
|
+
|
|
72
|
+
## 8. Provenance and drift
|
|
73
|
+
|
|
74
|
+
The source notes are the fact of record. When a fact changes, change the note first, then the page —
|
|
75
|
+
and grep the page for every place that fact was echoed (a summary line, a total, a status badge) before
|
|
76
|
+
declaring the update done; a page that repeats a number in three places goes stale in all three if only
|
|
77
|
+
one is touched.
|
|
78
|
+
|
|
79
|
+
## 9. Landing
|
|
80
|
+
|
|
81
|
+
A page's files are ordinary tracked content — they land via `ctxr-submit` like any other change. If a
|
|
82
|
+
change also touches a derived artifact in the sense `ctxr-derived-artifacts` covers (catalog, graph,
|
|
83
|
+
generated document sections), follow that skill's check-before-build discipline for those separately;
|
|
84
|
+
a published page is authored content, not something `ctxr-derived-artifacts` rebuilds.
|
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
End-of-session capture: propose what the session produced that is durable, write only what is approved.
|
|
2
2
|
The approval gate is what keeps the blast radius low — nothing is written without it.
|
|
3
3
|
|
|
4
|
+
A session produces durable material in two shapes, and they go to different places: a **fact** about
|
|
5
|
+
what happened is a note; a **rule** for how future work should go is a convention, and belongs in this
|
|
6
|
+
store's house conventions at `__HOUSE_CONVENTIONS_PATH__`, which is inlined into AGENTS.md and so loads
|
|
7
|
+
at the start of every session. One pass proposes both.
|
|
8
|
+
|
|
4
9
|
## When
|
|
5
10
|
|
|
6
11
|
Fires on the user's own closing utterance ("done", "ship it", "that's all", a sign-off) or an explicit
|
|
@@ -25,13 +30,41 @@ scratch work that landed on no decision.
|
|
|
25
30
|
|
|
26
31
|
Unsure → propose (the user can decline).
|
|
27
32
|
|
|
33
|
+
## What is a convention
|
|
34
|
+
|
|
35
|
+
A convention is a rule for future work. The test that separates it from a note: a note records that
|
|
36
|
+
something happened, a convention changes what happens next. "We chose Postgres, because X" is a note.
|
|
37
|
+
"Name migrations with the date first, because they sort" is a convention.
|
|
38
|
+
|
|
39
|
+
The default answer is NO — a store that gains a convention every session ends with a bloated,
|
|
40
|
+
self-contradicting document nobody reads. Propose one only when all four hold:
|
|
41
|
+
|
|
42
|
+
- It is a rule for future work, not a fact about past work.
|
|
43
|
+
- It applied more than once, or the user stated it as a correction.
|
|
44
|
+
- It is store-wide. A rule about one folder belongs in that folder's `README.md`, not here.
|
|
45
|
+
- It is not already in the shipped baseline — read that file first. Restating contexture's own
|
|
46
|
+
behavior as a house rule is the most likely way to get this wrong.
|
|
47
|
+
|
|
48
|
+
Propose REMOVALS on the same bar: a convention the session contradicted, or that no longer matches how
|
|
49
|
+
work actually goes, is worse than none — it teaches the next agent something false. The inlined section
|
|
50
|
+
also has a hard ceiling (`harness.convention_max_bytes`), so growth-only is not a maintenance strategy.
|
|
51
|
+
|
|
52
|
+
Each entry states the rule, why it exists, and how to apply it. The Why is not decoration: without the
|
|
53
|
+
observation that earned it, no future reader can tell whether a rule still holds or whether a one-off
|
|
54
|
+
calcified, so it never gets retired.
|
|
55
|
+
|
|
28
56
|
## Proposal — ONE message, empty proposal omitted
|
|
29
57
|
|
|
30
58
|
```
|
|
31
59
|
### Store notes
|
|
32
60
|
- A1 path: <layer>/<location>/<Title>.md
|
|
33
|
-
visibility: <value> — <one-line rationale; `ctxr note resolve` on a sibling shows the default>
|
|
34
61
|
sketch: bullets
|
|
62
|
+
|
|
63
|
+
### House conventions
|
|
64
|
+
- C1 add · <section> — <the rule, as an imperative>
|
|
65
|
+
why: <what goes wrong without it — the observation this session produced>
|
|
66
|
+
apply: <what to do concretely>
|
|
67
|
+
- C2 remove · <the rule, quoted> — <what contradicted it>
|
|
35
68
|
```
|
|
36
69
|
|
|
37
70
|
Secret-marker pass: any item whose content looks like a credential gets `⚠ suspected-secret:` on its
|
|
@@ -50,7 +83,6 @@ notes:
|
|
|
50
83
|
- id: A1
|
|
51
84
|
path: <layer>/<location>/<Title>.md
|
|
52
85
|
mode: create # or: append
|
|
53
|
-
visibility: <value> # optional; omit to take the location default
|
|
54
86
|
body: |
|
|
55
87
|
matching the frontmatter and style of the sibling notes (`ctxr-placement` decides the location)
|
|
56
88
|
```
|
|
@@ -59,7 +91,15 @@ Then run `ctxr session capture --proposal <file>`. It validates and writes every
|
|
|
59
91
|
one bad path never blocks the rest. These note commits ride the session pull request
|
|
60
92
|
(`ctxr-session-lifecycle`).
|
|
61
93
|
|
|
94
|
+
Approved conventions are a direct edit to `__HOUSE_CONVENTIONS_PATH__`, never the YAML above: `ctxr
|
|
95
|
+
session capture` writes NOTES — it takes a path and a body — and a guidance file is not a note. Edit it under the matching
|
|
96
|
+
section, then run `ctxr update` so AGENTS.md re-inlines it, and stage BOTH in the same commit: a staged
|
|
97
|
+
guidance change without a matching staged AGENTS.md regeneration fails `doctor --staged` and the
|
|
98
|
+
pre-commit hook refuses it. If the file does not exist yet (a store migrated in from before it was
|
|
99
|
+
seeded), say so in the proposal and create it with the approved entries — never unasked.
|
|
100
|
+
|
|
62
101
|
## Report from actual writes
|
|
63
102
|
|
|
64
103
|
Report exactly what the command reported — wrote / appended / refused (with reason) / skipped, by ID —
|
|
65
|
-
never from the proposal itself. A refused item is surfaced prominently with its reason.
|
|
104
|
+
never from the proposal itself. A refused item is surfaced prominently with its reason. For conventions,
|
|
105
|
+
report the section each entry landed in or was removed from, and that `ctxr update` re-inlined them.
|
|
@@ -35,4 +35,23 @@ time regardless — sequence those.
|
|
|
35
35
|
|
|
36
36
|
## Reclaiming
|
|
37
37
|
|
|
38
|
-
|
|
38
|
+
Scope with `ctxr session list` — it reports every worktree and branch this store recognizes as a session,
|
|
39
|
+
whichever checkout you run it from. Reclaiming is always an explicit go, never automatic; never claim a
|
|
40
|
+
worktree or branch was removed without having run the command yourself.
|
|
41
|
+
|
|
42
|
+
Establish that the pull request actually merged before removing anything, and get that from the forge —
|
|
43
|
+
`gh pr view <branch> --json state` reporting `MERGED` — not from git. If the store squash-merges (GitHub's
|
|
44
|
+
default), the squashed commit is not the branch's tip, so git's ancestry test calls a landed branch
|
|
45
|
+
unmerged forever: `git log <default>..<branch>` never empties and `git branch -d` never succeeds. Reading
|
|
46
|
+
a refusal there as "unmerged work" strands every session the store has ever landed.
|
|
47
|
+
|
|
48
|
+
With `MERGED` confirmed: `git worktree remove <path>`, then `git branch -d <branch>` — run from outside
|
|
49
|
+
that worktree (no command can remove the directory it is running from — `git worktree list` names the
|
|
50
|
+
canonical clone first). Leave the worktree removal unforced: it refuses on uncommitted work, and that
|
|
51
|
+
refusal is real, so stop and look rather than reaching for `--force`. If `git branch -d` refuses on a
|
|
52
|
+
pull request the forge says is merged, that is the squash case above, and `git branch -D` is the correct
|
|
53
|
+
finish — the forge, not the ancestry graph, is what established the work is safe.
|
|
54
|
+
|
|
55
|
+
To deliberately discard a session instead — abandoning unmerged work — `git worktree remove --force <path>`
|
|
56
|
+
then `git branch -D <branch>`. State plainly, before running it, that this destroys any uncommitted or
|
|
57
|
+
unmerged work in that worktree; it needs its own explicit go, distinct from the merged-and-clean case above.
|
|
@@ -13,14 +13,18 @@ a session, the conflict playbook, sequencing several pull requests) and is not r
|
|
|
13
13
|
staged set matches the intended unit. Derived artifacts under the cache paths never stage.
|
|
14
14
|
4. One coherent unit per pull request. If the session produced two disjoint units, say so and ask
|
|
15
15
|
whether to split.
|
|
16
|
-
5.
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
16
|
+
5. Validate: run `ctxr doctor` (store scope, not `--staged` — a session's job is to leave the whole store
|
|
17
|
+
healthy, not merely pass one commit's gate). Fix a failure; never bypass it, and never proceed past it.
|
|
18
|
+
6. Commit: `git commit -m "<message>"`, describing the unit staged in step 3.
|
|
19
|
+
7. Name the branch: if it still carries a generated name, `git branch -m "<name>"` before pushing — never
|
|
20
|
+
let a generated name reach the forge.
|
|
21
|
+
8. Run: `git push -u origin "<branch>"`, then `gh pr create --base __DEFAULT_BRANCH__ --title "<title>" --body
|
|
22
|
+
"<why / what changed / verification / follow-ups>"`. Do not stop to confirm first — the request to
|
|
23
|
+
submit is the consent for both, and `ctxr doctor` in step 5 is the gate on this path. If `gh` has no
|
|
24
|
+
reachable GitHub remote for this repository, `git push` still succeeds on its own — report the pushed
|
|
25
|
+
branch and give the operator the manual pull-request instructions instead of retrying `gh`.
|
|
26
|
+
9. Verify before any retry: a transport error can arrive AFTER the push or the pull-request open already
|
|
27
|
+
succeeded. Before retrying anything, `git ls-remote origin <branch>` and `gh pr list --head <branch>` —
|
|
28
|
+
never replay a push or a pull-request open blindly.
|
|
29
|
+
10. Hand off: report the pull request, then point at `ctxr-land` for after review — landing is a separate
|
|
30
|
+
decision and keeps its own explicit confirmation.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,116 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: eli5
|
|
3
|
+
description: "Explain any topic, code, concept, or error tailored to a specific audience's level of understanding. Use this skill whenever the user says 'explain like I am', 'ELI5', 'explain this to my', 'break this down for', 'dumb it down', 'simplify this for', or asks you to explain something to a specific person or audience type (e.g., 'explain this to a manager', 'how would I explain this to my mom', 'make this understandable for a 5th grader'). Also trigger when the user mentions wanting to understand something at a particular level, or asks for an explanation targeting a non-technical audience. Even partial matches like 'explain to my wife' or 'tell my boss' should trigger this skill."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Explain Like I Am... (ELI5)
|
|
7
|
+
|
|
8
|
+
You are an expert at taking complex topics and making them accessible to any audience. Your job is to explain the given topic in a way that perfectly matches the audience's background, vocabulary, and interests.
|
|
9
|
+
|
|
10
|
+
## Step 1: Identify the Audience
|
|
11
|
+
|
|
12
|
+
Parse the user's request to determine who the explanation is for. The audience falls into one of these categories:
|
|
13
|
+
|
|
14
|
+
### Ages
|
|
15
|
+
| Audience | Style |
|
|
16
|
+
|----------|-------|
|
|
17
|
+
| Age 5 | Super simple words. Use fun analogies with toys, animals, candy, playground. Short sentences. "Imagine you have a box of crayons..." |
|
|
18
|
+
| Age 10 | Elementary school level. Can handle basic cause-and-effect. Use school, sports, video game analogies. |
|
|
19
|
+
| Age 15 | Teenager. Can handle some abstraction. Use social media, phone, gaming references. Be slightly casual. |
|
|
20
|
+
| Age 20-30 | Young adult. Clear and direct. Real-world analogies from daily life, work, money. |
|
|
21
|
+
| Age 40+ | Mature adult. Respectful tone. Analogies from home ownership, career, family management. |
|
|
22
|
+
|
|
23
|
+
### Grade / Education Levels
|
|
24
|
+
| Audience | Style |
|
|
25
|
+
|----------|-------|
|
|
26
|
+
| 5th grade | Simple vocabulary, concrete examples, avoid jargon entirely. "Think of it like..." |
|
|
27
|
+
| Middle school | Can introduce basic terminology with definitions. Step-by-step logic. |
|
|
28
|
+
| Senior High | Can handle moderate complexity. Introduce proper terms but explain them. SAT-level vocabulary OK. |
|
|
29
|
+
| College Student | Academic framing. Can use technical terms with brief context. Theory + practical application. |
|
|
30
|
+
| Graduate school | Assume strong foundational knowledge. Focus on nuance, trade-offs, edge cases, and deeper implications. Be precise. |
|
|
31
|
+
|
|
32
|
+
### Job Roles
|
|
33
|
+
| Audience | They care about... | Frame explanations around... |
|
|
34
|
+
|----------|-------------------|------------------------------|
|
|
35
|
+
| Manager | Impact, timeline, risk, cost | Business outcomes, team implications, what decisions need to be made |
|
|
36
|
+
| Engineer | How it works, architecture, trade-offs | Technical details, implementation, performance, maintainability |
|
|
37
|
+
| Designer | User experience, visual impact, flow | How it affects the user, interaction patterns, accessibility |
|
|
38
|
+
| Director | Strategy, ROI, competitive advantage | Big picture, market position, resource allocation |
|
|
39
|
+
| Colleague | Practical context, shared work | How it affects their work, what they need to know to collaborate |
|
|
40
|
+
| Product Manager | User value, priorities, scope | Feature impact, user stories, what to build vs. skip |
|
|
41
|
+
|
|
42
|
+
### Relationships
|
|
43
|
+
| Audience | Tone | Analogy style |
|
|
44
|
+
|----------|------|---------------|
|
|
45
|
+
| Wife / Husband / Partner | Warm, conversational, patient | Household tasks, shared experiences, daily routines |
|
|
46
|
+
| Father / Mother / Parents | Respectful, clear, no condescension | Familiar technology they use, home analogies, generational bridges |
|
|
47
|
+
| Kids / Children | Playful, encouraging, short | Games, cartoons, school, animals |
|
|
48
|
+
| Friend | Casual, maybe humorous | Pop culture, shared interests, "you know how..." |
|
|
49
|
+
|
|
50
|
+
If the audience isn't explicitly stated, default to "Age 5" (classic ELI5).
|
|
51
|
+
|
|
52
|
+
## Step 2: Read the Source Material
|
|
53
|
+
|
|
54
|
+
Before explaining, make sure you fully understand what needs to be explained. This could be:
|
|
55
|
+
- **Code**: Read the relevant code files. Understand what the code does at a high level before translating.
|
|
56
|
+
- **A concept**: Break it into its core components.
|
|
57
|
+
- **An error message**: Understand the root cause, not just the surface text.
|
|
58
|
+
- **A technical document**: Extract the key points that matter.
|
|
59
|
+
- **Anything else**: Identify the essential "what" and "why."
|
|
60
|
+
|
|
61
|
+
## Step 3: Craft the Explanation
|
|
62
|
+
|
|
63
|
+
Follow these principles, scaled to the audience:
|
|
64
|
+
|
|
65
|
+
### Structure
|
|
66
|
+
1. **Start with the "what"** — one sentence that captures the essence
|
|
67
|
+
2. **Use an analogy** — connect to something the audience already knows
|
|
68
|
+
3. **Fill in details** — add layers only as appropriate for the audience level
|
|
69
|
+
4. **End with the "so what"** — why does this matter to them specifically?
|
|
70
|
+
|
|
71
|
+
### Language Calibration
|
|
72
|
+
|
|
73
|
+
For **simple audiences** (young ages, non-technical roles, family):
|
|
74
|
+
- No jargon. Zero. If a technical term is essential, define it immediately.
|
|
75
|
+
- One idea per sentence.
|
|
76
|
+
- Concrete over abstract. "The server is like a waiter at a restaurant" beats "the server handles client-server communication."
|
|
77
|
+
- Use "you" and "your" — make it personal.
|
|
78
|
+
|
|
79
|
+
For **technical audiences** (engineers, grad students):
|
|
80
|
+
- Use proper terminology — they'll feel patronized without it.
|
|
81
|
+
- Focus on the *interesting* parts: trade-offs, edge cases, design decisions.
|
|
82
|
+
- Compare to things they already know: "It's like a hash map but with X difference."
|
|
83
|
+
- Be concise — respect their existing knowledge.
|
|
84
|
+
|
|
85
|
+
For **business audiences** (managers, directors):
|
|
86
|
+
- Lead with impact and outcomes.
|
|
87
|
+
- Quantify where possible.
|
|
88
|
+
- Skip implementation details unless asked.
|
|
89
|
+
- Frame in terms of decisions: "This means we should..."
|
|
90
|
+
|
|
91
|
+
### Tone Matching
|
|
92
|
+
- Ages 5-10: Enthusiastic, like a favorite teacher. "Oh, this is a cool one!"
|
|
93
|
+
- Teenagers: Slightly casual but not cringey. No "fellow kids" energy.
|
|
94
|
+
- Professionals: Confident and clear. Respect their intelligence while bridging knowledge gaps.
|
|
95
|
+
- Family: Patient, warm, conversational. Like explaining over dinner.
|
|
96
|
+
|
|
97
|
+
## Examples
|
|
98
|
+
|
|
99
|
+
**User says**: "ELI5 what a database index is"
|
|
100
|
+
**Audience**: Age 5 (default)
|
|
101
|
+
**Response style**: "Imagine you have a huuuge book with thousands of pages. Now, if I asked you to find the page about dinosaurs, you could flip through every single page... or you could look at the table of contents at the front! A database index is like that table of contents. It helps the computer find things really fast without looking through everything."
|
|
102
|
+
|
|
103
|
+
**User says**: "Explain this API rate limiting to my manager"
|
|
104
|
+
**Audience**: Manager
|
|
105
|
+
**Response style**: "The API has a speed limit — we can only make 100 requests per minute. Right now we're hitting that limit during peak hours, which means some user requests are failing. We have two options: optimize our code to make fewer calls (1-2 days of work), or pay for a higher tier ($X/month). I'd recommend..."
|
|
106
|
+
|
|
107
|
+
**User says**: "Break down this React useEffect hook for a college student"
|
|
108
|
+
**Audience**: College Student
|
|
109
|
+
**Response style**: "useEffect is React's way of handling side effects — things that happen outside the normal render cycle, like API calls, subscriptions, or DOM manipulation. Think of it as a lifecycle hook (if you've seen class components) that combines componentDidMount, componentDidUpdate, and componentWillUnmount. The dependency array controls when it re-runs..."
|
|
110
|
+
|
|
111
|
+
## Important Reminders
|
|
112
|
+
|
|
113
|
+
- Never talk down to anyone. A 5-year-old explanation should feel delightful, not dumbing-down. A manager explanation should feel empowering, not dismissive of their intelligence.
|
|
114
|
+
- When explaining code, always explain the *purpose* first, then the mechanism. Nobody cares about syntax until they know why it exists.
|
|
115
|
+
- If the topic is genuinely complex and the audience is very non-technical, it's OK to simplify ruthlessly. Getting the core idea across at 80% accuracy is better than a 100% accurate explanation that loses the audience.
|
|
116
|
+
- Match the length to the audience: short and sweet for young kids, more detailed for technical audiences who want depth.
|
|
@@ -0,0 +1,177 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: frontend-design
|
|
3
|
+
description: Guidance for distinctive, intentional visual design when building new UI or reshaping an existing one. Helps with aesthetic direction, typography, and making choices that don't read as templated defaults.
|
|
4
|
+
license: Complete terms in LICENSE.txt
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Frontend Design
|
|
8
|
+
|
|
9
|
+
Approach this as the design lead at a small studio known for giving every client a visual identity that could not be mistaken for anyone else's. This client has already rejected proposals that felt templated, and is paying for a distinctive point of view: make deliberate, opinionated choices about palette, typography, and layout that are specific to this brief, and take one real aesthetic risk you can justify.
|
|
10
|
+
|
|
11
|
+
## Ground it in the subject
|
|
12
|
+
|
|
13
|
+
If the brief does not pin down what the product or subject is, pin it yourself before designing: name one concrete subject, its audience, and the page's single job, and state your choice. If there's any information in your memory about the human's preferences, context about what they're building, or designs you've made before – use that as a hint. The subject's own world, its materials, instruments, artifacts, and vernacular, is where distinctive choices come from. Build with the brief's real content and subject matter throughout.
|
|
14
|
+
|
|
15
|
+
## Design principles
|
|
16
|
+
|
|
17
|
+
For web designs, the hero is a thesis. Open with the most characteristic thing in the subject's world, in whatever form makes sense for it: a headline, an image, an animation, a live demo, an interactive moment. Be deliberate with your choice: a big number with a small label, supporting stats, and a gradient accent is the template answer, only use if that's truly the best option.
|
|
18
|
+
|
|
19
|
+
Typography carries the personality of the page. Pair the display and body faces deliberately, not the same families you would reach for on any other project, and set a clear type scale with intentional weights, widths, and spacing. Make the type treatment itself a memorable part of the design, not a neutral delivery vehicle for the content.
|
|
20
|
+
|
|
21
|
+
Structure is information. Structural devices, numbering, eyebrows, dividers, labels, should encode something true about the content, not decorate it. Many generic designs use numbered markers (01 / 02 / 03), but that's only appropriate if the content actually is a sequence - like a real process or a typed timeline where order carries information the reader needs. Question if choices like numbered markers actually make sense before incorporating them.
|
|
22
|
+
|
|
23
|
+
Leverage motion deliberately. Think about where and if animation can serve the subject: a page-load sequence, a scroll-triggered reveal, hover micro-interactions, ambient atmosphere. An orchestrated moment usually lands harder than scattered effects; choose what the direction calls for. However, sometimes less is more, and extra animation contributes to the feeling that the design is AI-generated.
|
|
24
|
+
|
|
25
|
+
Match complexity to the vision. Maximalist directions need elaborate execution; minimal directions need precision in spacing, type, and detail. Elegance is executing the chosen vision well.
|
|
26
|
+
|
|
27
|
+
Consider written content carefully. Often a design brief may not contain real content, and it's up to you to come up with copy. Copy can make a design feel as templated as the design itself. See the below section on writing for more guidance.
|
|
28
|
+
|
|
29
|
+
## Process: brainstorm, explore, plan, critique, build, critique again
|
|
30
|
+
|
|
31
|
+
For calibration: AI-generated design right now clusters around three looks: (1) a warm cream background (near #F4F1EA) with a high-contrast serif display and a terracotta accent; (2) a near-black background with a single bright acid-green or vermilion accent; (3) a broadsheet-style layout with hairline rules, zero border-radius, and dense newspaper-like columns. All three are legitimate for some briefs, but they are defaults rather than choices, and they appear regardless of subject. Where the brief pins down a visual direction, follow it exactly — the brief's own words always win, including when it asks for one of these looks. Where it leaves an axis free, don't spend that freedom on one of these defaults. Just like a human designer who's hired, there's often a careful balance between doing what you're good at and taking each project as a chance to experiment and learn.
|
|
32
|
+
|
|
33
|
+
Work in two passes. First, brainstorm a short design plan based on the human's design brief: create a compact token system with color, type, layout, and signature. Color: describe the palette as 4–6 named hex values. Type: the typefaces for 2+ roles (a characterful display face that's used with restraint, a complementary body face, and a utility face for captions or data if needed). Layout: a layout concept, using one-sentence prose descriptions and ASCII wireframes to ideate and compare. Signature: the single unique element this page will be remembered by that embodies the brief in an appropriate way.
|
|
34
|
+
|
|
35
|
+
Then review that plan against the brief before building: if any part of it reads like the generic default you would produce for any similar page (work through a similar prompt to see if you arrive somewhere similar) rather than a choice made for this specific brief — revise that part, say what you changed and why. Only after you've confirmed the relative uniqueness of your design plan should you start to write the code, following the revised plan exactly and deriving every color and type decision from it.
|
|
36
|
+
|
|
37
|
+
When writing the code, be careful of structuring your CSS selector specificities. It's easy to generate CSS classes that cancel each other out (especially with a type-based selector like .section and a element-based selector like .cta). This can happen often with paddings/margins between sections.
|
|
38
|
+
|
|
39
|
+
Try to do a lot of this planning and iteration in your thinking, and only show ideas to the user when you have higher confidence it'll delight them.
|
|
40
|
+
|
|
41
|
+
## Restraint and self-critique
|
|
42
|
+
|
|
43
|
+
Spend your boldness in one place. Let the signature element be the one memorable thing, keep everything around it quiet and disciplined, and cut any decoration that does not serve the brief. Not taking a risk can be a risk itself! Build to a quality floor without announcing it: responsive down to mobile, visible keyboard focus, reduced motion respected. Critique your own work as you build, taking screenshots if your environment supports it – a picture is worth 1000 tokens. Consider Chanel's advice: before leaving the house, take a look in the mirror and remove one accessory. Human creators have memory and always try to do something new, so if you have a space to quickly jot down notes about what you've tried, it can help you in future passes.
|
|
44
|
+
|
|
45
|
+
## More on writing in design
|
|
46
|
+
|
|
47
|
+
Words appear in a design for one reason: to make it easier to understand, and therefore easier to use. They are design material, not decoration. Bring the same intentionality to copy that you would bring to spacing and color. Before writing anything, ask what the design needs to say, and how it can best be said to help the person navigate the experience.
|
|
48
|
+
|
|
49
|
+
Write from the end user's side of the screen. Name things by what people control and recognize, never by how the system is built. A person manages notifications, not webhook config. Describe what something does in plain terms rather than selling it. Being specific is always better than being clever.
|
|
50
|
+
|
|
51
|
+
Use active voice as default. A control should say exactly what happens when it's used: "Save changes," not "Submit." An action keeps the same name through the whole flow, so the button that says "Publish" produces a toast that says "Published." The vocabulary of an interface is the signposting for someone navigating the product. Cohesion and consistency are how people learn their way around.
|
|
52
|
+
|
|
53
|
+
Treat failure and emptiness as moments for direction, not mood. Explain what went wrong and how to fix it, in the interface's voice rather than a person's. Errors don't apologize, and they are never vague about what happened. An empty screen is an invitation to act.
|
|
54
|
+
|
|
55
|
+
Keep the register conversational and tuned: plain verbs, sentence case, no filler, with tone matched to the brand and the audience. Let each element do exactly one job. A label labels, an example demonstrates, and nothing quietly does double duty.
|
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
import type { ForgeAdapter, PullRequestLifecycleState, PullRequestMergeability } from './types.js';
|
|
2
|
-
/** GitHub's own vocabulary, normalized to the adapter interface's small unions — kept pure and exported so tests exercise the mapping without a subprocess. */
|
|
3
|
-
export declare function mapPullRequestState(ghState: string): PullRequestLifecycleState;
|
|
4
|
-
export declare function mapMergeability(ghMergeable: string): PullRequestMergeability;
|
|
5
|
-
/**
|
|
6
|
-
* The reference forge adapter, shelling out to `gh` (same tool, same
|
|
7
|
-
* pattern as `git` itself) rather than a token-based REST client — simpler
|
|
8
|
-
* to implement correctly, and consistent with how every other git-adjacent
|
|
9
|
-
* operation in this codebase is invoked.
|
|
10
|
-
*/
|
|
11
|
-
export declare const githubForgeAdapter: ForgeAdapter;
|
|
12
|
-
//# sourceMappingURL=github.d.ts.map
|