docs: a followable demo, npx path, return shape, accurate CONTRIBUTING - #26
Conversation
There was a problem hiding this comment.
Pull request overview
Updates project documentation based on an audit, aiming to make the docs accurate and runnable: clarifies the vendored dspack-gen core situation, fixes the Quick start workflow, makes the shadcn demo reproducible, and refreshes repo governance/security wording.
Changes:
- Fix Quick start example filename/versioning and add an
npxinstall note. - Document MCP tool return shape expectations and clarify the vendored
dspack-gencore pin narrative. - Update demo and contributor/security docs to remove broken links and reflect current tool/version reality.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| SECURITY.md | Clarifies generation tools apply to dspack 0.3/0.4 while preserving the read-only invariant text. |
| README.md | Fixes Quick start filename collision, documents MCP return shape, and updates vendored-core pin explanation. |
| docs/demo-shadcn.md | Makes the demo followable by explicitly fetching/running the v0.2 example dspack. |
| CONTRIBUTING.md | Removes outdated “pre-alpha” language and fixes references to non-existent examples/README.md. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
|
||
| ```bash | ||
| # 1. Install | ||
| # 1. Install (or skip: `npx @aestheticfunction/ds-mcp` works without installing) |
| **Currently vendored: dspack-gen `v0.1.2`** (dspack-gen's own latest release | ||
| is 0.3.2). The pin therefore trails upstream, and | ||
| `scripts/check-core-pin.mjs` reports that drift by design — run it to see | ||
| which `src/core` files changed since the pin. Practically: `validate-ui`'s |
|
On the two red checks — both pre-existing, neither from this PR. This repo's CI last ran on 2026-07-22 (green); the drift accumulated after, and this docs PR is simply the first run since.
They are coupled — verified, not assumed. Running With the working tree as-is, |
51bb6a5 to
0bb7ae0
Compare
Ecosystem documentation audit. Each claim re-verified by running the code. - Quick start downloaded shadcn-ui-v04.dspack.json and wrote it to the unversioned shadcn-ui.dspack.json — the exact collision the changelog says the rename existed to prevent. Keeps the version in the filename now, and documents the npx path (verified working), so the local-install route is no longer a dead end. - docs/demo-shadcn.md told readers to download via the Quick start and then run a v0.2 file the Quick start never produces. It now fetches v0.2 explicitly (URL verified 200) and says plainly that the walkthrough's counts are exact for v0.2 while the Quick start ships v0.4. - CONTRIBUTING claimed a "pre-alpha repository" with a "planned tool surface" and pointed twice at examples/README.md, which does not exist. Eleven tools ship; links now point at docs/README.md and examples/. - SECURITY said "the dspack 0.3 generation tools"; the code gates on 0.3 and 0.4. - README now documents the MCP return shape (JSON inside a single text block, errors in the same channel rather than as protocol errors) — the one thing the stated "MCP client authors" audience needs and no doc gave. The vendored-core paragraph this PR originally rewrote is left untouched: the pin has since moved to v0.3.2 in #27, which rewrites that paragraph to the post-re-pin truth. Keeping the two PRs off the same lines lets them merge in either order. (#27 also corrects two claims this branch made: `containment` is a gate-S2 vocabulary check rather than an S3 rule family, and `forbiddenCategories` was already evaluated at v0.1.2 — only `requiredCategories` was genuinely unevaluatable.) Verified: build, unit tests, and scripts/smoke.sh all pass. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
0bb7ae0 to
fa01415
Compare
From an ecosystem-wide documentation audit. Every claim re-verified by running the code.
npxpath (verified working), so the local-install route is no longer a dead end.examples/README.md, which does not exist.Rebased onto main after #27
This PR originally also rewrote the vendored-core paragraph to state the pin honestly as v0.1.2. #27 superseded that — it moved the pin to v0.5.0 and rewrote the paragraph to the post-re-pin truth. This branch no longer touches those lines, so the rebase was conflict-free and that paragraph now reads as #27 left it.
#27 also corrected two claims this branch originally made, both verified by diffing
src/coreacross the pin commits:containment(spec v0.4 §5.1) is a gate-S2 vocabulary check, not an S3 rule family — it lives invocabulary.ts.forbiddenCategorieswas already evaluated at v0.1.2. OnlyrequiredCategories(§4.3) was genuinely unevaluatable.This branch was also cut before #25, so its diff previously appeared to remove the adoption-guide link. That link is now correctly preserved.
Verification
On the rebased branch, with #27 in main:
npm ciclean, 94/94 tests,scripts/smoke.shpassed,check-sync.mjsexit 0,check-core-pin.mjs"the pin is exactly the latest release tag". The eleven-tool surface, env/CLI vars, and client configs audited clean.🤖 Generated with Claude Code