Skip to content

Commit 3a996cc

Browse files
docs: prepare Solid 2 RC docs for publication
Polish async and JSX guidance, curate generated references, and add staging safeguards so the rebuilt documentation can be reviewed safely before launch. Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent d012a27 commit 3a996cc

128 files changed

Lines changed: 1704 additions & 552 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.

.github/workflows/static_checks.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ on:
44
push:
55
branches:
66
- main
7+
- v2-rebuild
78
pull_request:
89
branches:
910
- main
@@ -40,3 +41,6 @@ jobs:
4041

4142
- name: Check formatting
4243
run: pnpm exec prettier . --check
44+
45+
- name: Tone lint
46+
run: pnpm lint:tone

.prettierignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
.solid
2+
.pnpm-store
23
dist
34
*.min.*
45
package-lock.json

WRITING.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -404,16 +404,17 @@ This is a list of Solid-specific words and what they mean. In the second column,
404404

405405
These are technical; use them with the default assumption that the reader doesn't know what they mean.
406406

407-
| Terms to use | Terms not to use | Definition |
408-
| --------------------------------- | ------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
409-
| Computation, reactive computation | _Not to be confused with_: computed | A scope that automatically reruns when its dependencies change (it doesn't necessarily _have_ dependencies). |
410-
| Core primitive | API function | A primitive provided by the Solid core library; this typically provides reactive behaviors but not necessarily ( `createContext` does not). |
411-
| Custom primitive | hook | A primitive created outside of the Solid core library; i.e., a function that provides a composable piece of functionality. |
412-
| Ownership, owns | | A one-to-many relationship between computations; if a computation "owns" one or more other computations, all its owned computations are cleaned up when it is cleaned up. |
413-
| Primitive | Hook | A function that serves as a building block of reactivity or behavior. usually begins with `create` or `use`. |
414-
| Reactive value | Signal (don't use to describe a general reactive value) | A value that can be tracked (includes signals, memos, properties of `props` and stores). |
415-
| Reactivity | | A system for writing expressions or behaviors that depend on certain values and execute when those values change. |
416-
| Root | | A computation that has no owner. created by `createRoot`. |
417-
| Scope | _Not to be confused with:_ root, effect (specific kinds of scopes) | A body of a function (a chunk of code). |
418-
| Solid | SolidJS (unless outside the community/internal writings) | A JavaScript framework made up of a library (providing primitives and UI utilities) and a compiler (allowing you to write in JSX). Its differentiating feature is its reactivity system. |
419-
| Tracking scope | Tracking context, reactive context, reactive scope, reactive root | A scope that, when run, Solid automatically tracks all read signals |
407+
| Terms to use | Terms not to use | Definition |
408+
| --------------------------------- | ------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
409+
| Computation, reactive computation | _Not to be confused with_: computed | A scope that automatically reruns when its dependencies change (it doesn't necessarily _have_ dependencies). |
410+
| Held update | Transition, except in an API name or internal implementation detail | An update whose commit waits for async work after a previous answer exists. The current committed view remains visible until the work settles. |
411+
| Core primitive | API function | A primitive provided by the Solid core library; this typically provides reactive behaviors but not necessarily ( `createContext` does not). |
412+
| Custom primitive | hook | A primitive created outside of the Solid core library; i.e., a function that provides a composable piece of functionality. |
413+
| Ownership, owns | | A one-to-many relationship between computations; if a computation "owns" one or more other computations, all its owned computations are cleaned up when it is cleaned up. |
414+
| Primitive | Hook | A function that serves as a building block of reactivity or behavior. usually begins with `create` or `use`. |
415+
| Reactive value | Signal (don't use to describe a general reactive value) | A value that can be tracked (includes signals, memos, properties of `props` and stores). |
416+
| Reactivity | | A system for writing expressions or behaviors that depend on certain values and execute when those values change. |
417+
| Root | | A computation that has no owner. created by `createRoot`. |
418+
| Scope | _Not to be confused with:_ root, effect (specific kinds of scopes) | A body of a function (a chunk of code). |
419+
| Solid | SolidJS (unless outside the community/internal writings) | A JavaScript framework made up of a library (providing primitives and UI utilities) and a compiler (allowing you to write in JSX). Its differentiating feature is its reactivity system. |
420+
| Tracking scope | Tracking context, reactive context, reactive scope, reactive root | A scope that, when run, Solid automatically tracks all read signals |

env.d.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
interface ImportMetaEnv {
2-
readonly VITE_ORAMA_ENDPOINT: string;
3-
readonly VITE_ORAMA_API_KEY: string;
4-
readonly VITE_ORAMA_SECURE_PROXY: string;
2+
readonly VITE_ORAMA_PROJECT_ID?: string;
3+
readonly VITE_ORAMA_PUBLIC_API_KEY?: string;
54
}
65

76
interface ImportMeta {
@@ -12,7 +11,8 @@ declare namespace NodeJS {
1211
interface ProcessEnv {
1312
readonly ORAMA_PROJECT_ID: string;
1413
readonly ORAMA_DATASOURCE_ID: string;
15-
readonly ORAMA_PUBLIC_API_KEY: string;
1614
readonly ORAMA_PRIVATE_API_KEY: string;
15+
readonly SITE_URL?: string;
16+
readonly DEPLOY_PRIME_URL?: string;
1717
}
1818
}
Lines changed: 109 additions & 0 deletions
Loading
Lines changed: 146 additions & 0 deletions
Loading

scripts/build-llms.mjs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,11 @@ import { fileURLToPath } from "node:url";
44

55
const ROOT = resolve(dirname(fileURLToPath(import.meta.url)), "..");
66
const OUTPUT_DIR = resolve(ROOT, process.argv[2] ?? "dist");
7-
const SITE_ORIGIN = new URL(process.env.SITE_URL ?? "https://docs.solidjs.com");
7+
const SITE_ORIGIN = new URL(
8+
process.env.SITE_URL ??
9+
process.env.DEPLOY_PRIME_URL ??
10+
"https://docs.solidjs.com"
11+
);
812
const INDEX_PATH = resolve(OUTPUT_DIR, "llms.txt");
913
const FULL_PATH = resolve(OUTPUT_DIR, "llms-full.txt");
1014

0 commit comments

Comments
 (0)