Skip to content

Commit c95f58b

Browse files
authored
docs: entrance accuracy pass, plainer welcome path, remove root fingerprint (#216)
- Update README and AGENTS/CLAUDE init rows to the shipped skeleton starter; add ghost export and steering-eval to command/package tables - Document ghost export on the docs site (cli-reference) - Rewrite entrance docs in plain language: reorder README around install and agent prompts, cut untaught jargon from quickstart/getting-started, rebuild the npm README with the missing beta warning - Enforce the entrance-docs vocabulary in check-terminology.mjs - Remove the root .ghost fingerprint; salvage its voice conventions into CLAUDE.md conventions - Migrate demo fingerprints from legacy haunts/ to flat checks/ (local only)
1 parent df10e70 commit c95f58b

17 files changed

Lines changed: 264 additions & 312 deletions
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@design-intelligence/ghost": patch
3+
---
4+
5+
Refresh the entrance docs: accurate skeleton/body init descriptions, a documented `ghost export`, and plainer language on the welcome path.

.ghost/.gitignore

Lines changed: 0 additions & 2 deletions
This file was deleted.

.ghost/anti-goal.surface-sprawl.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

.ghost/decision.flat-corpus.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

.ghost/glossary.md

Lines changed: 0 additions & 24 deletions
This file was deleted.

.ghost/index.md

Lines changed: 0 additions & 29 deletions
This file was deleted.

.ghost/manifest.yml

Lines changed: 0 additions & 2 deletions
This file was deleted.

.ghost/principle.byoa-boundary.md

Lines changed: 0 additions & 28 deletions
This file was deleted.

.ghost/principle.voice.md

Lines changed: 0 additions & 25 deletions
This file was deleted.

CLAUDE.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ edits and checks.
9191
| `packages/ghost` | yes: `@design-intelligence/ghost` | The public package. Ships the `ghost` CLI, node authoring, corpus validation, gather/pull/pulse, review packet assembly, and the unified skill bundle. Shared runtime lives in `packages/ghost/src/ghost-core`. |
9292
| `packages/vessel-react` | no | A standalone shadcn component registry plus `vessel-mcp` MCP server: the opinionated default reference body. Design-system-agnostic; nothing in Ghost requires it. |
9393
| `packages/vessel-light` | no | Vessel's design language as a portable `.ghost/` fingerprint package for agents writing raw HTML/CSS. No build, no dependencies. |
94+
| `packages/steering-eval` | no | Before/after evaluation harness: measures what handing an agent a `.ghost` fingerprint buys, as a deterministic `report.html`. |
9495
| `apps/docs` | no | Docs site. |
9596

9697
## CLI Commands
@@ -99,13 +100,14 @@ Core workflow:
99100

100101
| Command | Description |
101102
| --- | --- |
102-
| `ghost init` | Scaffold `.ghost/` with a manifest, starter glossary, and a starter `index.md`. `--with checks` also adds the checks directory. |
103+
| `ghost init` | Scaffold `.ghost/` with the skeleton starter: manifest, glossary, `index.md`, grammar nodes, and unanswered signature dials. `--template minimal` writes only the manifest/glossary/index starter; `--body vessel-light` installs a full inhabited fingerprint instead. `--with checks` also adds the checks directory. |
103104
| `ghost checks init` | Scaffold `.ghost/checks/` with an example review assertion. |
104105
| `ghost validate` | Validate the package: manifest shape, node validity, material locators, check references, and glossary kind prefixes. |
105106
| `ghost gather [ask…]` | Emit the fingerprint menu for the agent to select from. |
106107
| `ghost pull <id> [<id>…]` | Emit selected nodes' bodies and materials; append the selection to the local `.ghost/.events` tape. |
107108
| `ghost review` | Emit an advisory review packet for a diff using material-backed nodes and checks (requires `.ghost/checks/`). |
108109
| `ghost pulse` | Summarize local gather/pull events from `.ghost/.events`. |
110+
| `ghost export` | Package the fingerprint as a portable tarball with a materials audit (`--strict` fails on stranded locators). |
109111
| `ghost skill install` | Install the unified `ghost` skill bundle. |
110112

111113
Advanced/maintenance:
@@ -151,6 +153,14 @@ Use `patch` for fixes and docs, `minor` for new commands/flags/exports, and
151153

152154
## Conventions
153155

156+
- Shipped prose is plain, precise, restrained, and product-minded. When
157+
completeness and compactness compete, compactness wins; link out for depth.
158+
Concrete over aspirational: name the decision a truth forces, not the value
159+
it serves. Teach terms by worked example before defining them. No em dashes,
160+
no brand-deck filler, no exclamation points. `scripts/check-terminology.mjs`
161+
enforces the retired-vocabulary list; run `pnpm check:terminology` before
162+
pushing, and when renaming a concept, retire the old word everywhere in the
163+
same change and add it to the forbidden list.
154164
- Keep publishable runtime code self-contained in `packages/ghost`; no
155165
`workspace:*` runtime dependencies in the packed public artifact.
156166
- The canonical on-disk form is a flat `.ghost/` package: `manifest.yml` plus

0 commit comments

Comments
 (0)