Repository navigation
docs: a reference page per diagnostic code, generated from the repair skill - #1658
Merged
Merged
Conversation
… skill One page per diagnostic code under /reference/solid-js/diagnostics, plus an index with the console report explained (the message, the `in` line, the `at` line, the element argument) and a table of every code. The pages are written by scripts/extract-diagnostics.mjs from the reactivity-diagnostics skill and diagnostics.json in a solidjs/solid checkout, for a person: what you saw, why it fires, how to fix it, and the @solidjs/diagnostics assertion that guards it. The console footer links these pages. DEV/OBSERVE reference pages document DiagnosticEvent.loc and the `at` line; the vite-plugin options page gains the `locations` sourceNames kind and the root it is relative to; the guides link the index. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Ka6h98478umeFadcRV1KLY
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Ka6h98478umeFadcRV1KLY
|
|
✅ Deploy Preview for solid-docs-v2 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Before: a dev console warning's only guidance was the agent repair skill (
node_modules/solid-js/skills/reactivity-diagnostics/SKILL.md) and its GitHub URL, and the docs site had no page per diagnostic code.After: every one of the 66 diagnostic codes has a page at
/reference/solid-js/diagnostics/<slug>(e.g./reference/solid-js/diagnostics/strict-read-untracked) written for a human: what you saw, why it fires, how to fix it, how to assert it in tests. An index page lists every code with its kind, severity and trigger. The companion runtime change (solidjs/solid,sourceNames.locations) points the console footer's first line at these pages, and thedev/observereference pages, the vite plugin options page and the debugging guides describe the newat src/App.tsx:18:3line andlocfield.The pages are generated:
pnpm sync:diagnostics --source <solid checkout>(scripts/extract-diagnostics.mjs) reads the skill's per-code sections andpackages/solid/diagnostics.json, likesync:refdoes for the API reference. The generator is idempotent, fails if a hand-picked split marker stops matching, and rewrites three skill sentences for the tone lint.FLUSH_IN_ACTIONhas a skill section but nodiagnostics.jsonentry (it is thrown, not emitted), so it gets no page.How: new generator script wired into
package.json; 67 generated pages undersrc/routes/reference/(1)solid-js/(8)diagnostics/; hand edits todev.mdx,observe.mdx, the vite plugin options page, the AI tools, debugging and observability guides, the solid-js reference index, the sidebar config (group collapsed) andbuild-llms.mjs(small corpus links the index only).pnpm build,lint:tone, prettier, eslint andcheck:typespass.🤖 Generated with Claude Code
https://claude.ai/code/session_01Ka6h98478umeFadcRV1KLY
Generated by Claude Code