Skip to content

Commit 0b5fd4a

Browse files
ryansolidclaude
andauthored
docs: a reference page per diagnostic code, generated from the repair skill (#1658)
* docs: a reference page per diagnostic code, generated from the repair 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 * docs: regenerate GRAPH_GROWTH page for the session-wide count (#4103) Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Ka6h98478umeFadcRV1KLY --------- Co-authored-by: Claude <noreply@anthropic.com>
1 parent b2165f7 commit 0b5fd4a

79 files changed

Lines changed: 4532 additions & 25 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎README.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,17 @@ pnpm dev
9090

9191
This will start your the app at [localhost:3000](http://localhost:3000) or the next available port.
9292

93+
### Generated reference pages
94+
95+
Two scripts write reference pages from a local checkout of [solidjs/solid](https://github.com/solidjs/solid) (branch `next`); the pages they write carry a comment naming the script, and edits belong upstream, not in the page.
96+
97+
```sh
98+
pnpm sync:ref --source ../solid --skip-fetch # solid-js, @solidjs/web, @solidjs/signals from the JSDoc
99+
pnpm sync:diagnostics --source ../solid # one page per diagnostic code from the repair skill
100+
```
101+
102+
Without `--source`, `sync:ref` makes a sparse checkout under `/tmp/solid-v2-source` that `sync:diagnostics` reads too.
103+
93104
### Framework and Theme
94105

95106
The docs are built on [SolidBase](https://solidbase.dev) and uses the [Osmium Theme](./osmium).

‎package.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
"check:lint": "eslint --flag unstable_native_nodejs_ts_config .",
1717
"check:types": "tsc --noEmit",
1818
"sync:ref": "node scripts/extract-solid-ref.mjs",
19+
"sync:diagnostics": "node scripts/extract-diagnostics.mjs",
1920
"check:examples": "node scripts/check-examples.mjs",
2021
"lint:tone": "node scripts/lint-tone.mjs"
2122
},

‎scripts/build-llms.mjs‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,7 @@ async function buildSmallCorpus(title) {
177177
"",
178178
`Index: ${new URL("/llms.txt", SITE_ORIGIN)}`,
179179
`Full corpus: ${new URL("/llms-full.txt", SITE_ORIGIN)}`,
180+
`Diagnostic codes: ${new URL("/reference/solid-js/diagnostics.md", SITE_ORIGIN)} (one page per code, linked from each console report)`,
180181
"",
181182
primerBody,
182183
"",

0 commit comments

Comments
 (0)