Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,17 @@ pnpm dev

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

### Generated reference pages

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.

```sh
pnpm sync:ref --source ../solid --skip-fetch # solid-js, @solidjs/web, @solidjs/signals from the JSDoc
pnpm sync:diagnostics --source ../solid # one page per diagnostic code from the repair skill
```

Without `--source`, `sync:ref` makes a sparse checkout under `/tmp/solid-v2-source` that `sync:diagnostics` reads too.

### Framework and Theme

The docs are built on [SolidBase](https://solidbase.dev) and uses the [Osmium Theme](./osmium).
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
"check:lint": "eslint --flag unstable_native_nodejs_ts_config .",
"check:types": "tsc --noEmit",
"sync:ref": "node scripts/extract-solid-ref.mjs",
"sync:diagnostics": "node scripts/extract-diagnostics.mjs",
"check:examples": "node scripts/check-examples.mjs",
"lint:tone": "node scripts/lint-tone.mjs"
},
Expand Down
1 change: 1 addition & 0 deletions scripts/build-llms.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,7 @@ async function buildSmallCorpus(title) {
"",
`Index: ${new URL("/llms.txt", SITE_ORIGIN)}`,
`Full corpus: ${new URL("/llms-full.txt", SITE_ORIGIN)}`,
`Diagnostic codes: ${new URL("/reference/solid-js/diagnostics.md", SITE_ORIGIN)} (one page per code, linked from each console report)`,
"",
primerBody,
"",
Expand Down
Loading
Loading