docs: rebuild documentation for Solid 2 - #1626
Closed
ryansolid wants to merge 48 commits into
Closed
Conversation
Co-authored-by: Cursor <cursoragent@cursor.com>
Implements the rebuild proposal: single-version site with the new IA (getting-started, concepts, building-apps, routing, guides, migration, reference by package). Moves the generated v2 reference under reference/solid-js and reference/solid-web, relocates the Meta 1.0 docs, adds planned-page stubs, and removes the per-project version routing, project tabs, and legacy redirect middleware. Co-authored-by: Cursor <cursoragent@cursor.com>
Points extract-solid-ref.mjs at src/routes/reference with solid-js and solid-web groups, makes cleanup respect hand-written pages, regenerates against the current next SHA (adds affects, clientOnly, httpStatus, httpHeader; hides the host-integration surface pending its own section; drops the removed renderToStringAsync). Co-authored-by: Cursor <cursoragent@cursor.com>
WRITING.md gains a section for AI-drafted content: claims traceable to source, banned filler and marketing words, no history-relative framing outside migration guides. scripts/lint-tone.mjs enforces the mechanical parts over src/routes mdx (errors for hand-written pages, warnings for generated ones) and runs in the static checks workflow. Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Curate the generated llms.txt index and provide a matching single-file corpus for tools that cannot follow per-page links. Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Explain the source-backed component, JSX, rendering, SSR, and hydration behavior needed to replace the planned concept stubs. Co-authored-by: Cursor <cursoragent@cursor.com>
Document commit-zero SSR and hydration behavior from the final Solid 2.0 source, and remove mismatched dynamic API reference links. Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Replace the planned stubs with source-traced guidance for async state, mutation coordination, and boundary ownership. Co-authored-by: Cursor <cursoragent@cursor.com>
Explain how loading values provide first-flight content without boundary or pending state, including hydration and retry behavior. Co-authored-by: Cursor <cursoragent@cursor.com>
Lead with normal loading, stale-content, error, and reveal patterns while keeping committed first values as an advanced option. Co-authored-by: Cursor <cursoragent@cursor.com>
Document start-mode structure, Vite styling and assets, and typed environment boundaries from the current plugin and templates. Co-authored-by: Cursor <cursoragent@cursor.com>
Narrow app shell behavior to verified plugin contracts and maintained template examples, including entry precedence, CSS delivery, and environment security boundaries. Co-authored-by: Cursor <cursoragent@cursor.com>
Replace the planned pages with source-backed guidance for server functions, sessions, middleware, API routes, and deployment. Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Explain router-neutral request and single-flight contracts, then map the supported TanStack Router and Query template onto them. Co-authored-by: Cursor <cursoragent@cursor.com>
Ground request, single-flight, and TanStack hydration statements in the current plugin, runtime, router, and template implementations. Co-authored-by: Cursor <cursoragent@cursor.com>
Document the Router 2 task flow and public package surface from the pinned local source so application and integration behavior can be reviewed independently of migration material. Co-authored-by: Cursor <cursoragent@cursor.com>
Remove publication-only source notes and tighten the Router guides for direct, scannable task guidance while preserving immutable reference provenance. Co-authored-by: Cursor <cursoragent@cursor.com>
Document the source-backed vite-plugin-solid and filesystem-routing public APIs, options, generated modules, and output contracts. Co-authored-by: Cursor <cursoragent@cursor.com>
Align source metadata and sidebar ordering with reference conventions while tightening prose and preserving public route slugs. Co-authored-by: Cursor <cursoragent@cursor.com>
Document the verified upgrade order and behavioral changes so applications can migrate the core runtime without relying on inferred API renames. Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Document the separate SolidStart 1 and 2 extraction paths so applications move onto the verified start-mode runtime without implying an in-place upgrade. Co-authored-by: Cursor <cursoragent@cursor.com>
Avoid the unsupported automatic step components so the guide prerenders and hydrates correctly. Co-authored-by: Cursor <cursoragent@cursor.com>
Replace the planned stub with a source-pinned, incremental path from the shipped component and data APIs to createRouter. Co-authored-by: Cursor <cursoragent@cursor.com>
Keep reviewer provenance in the handoff while leaving the published migration page focused on user-facing behavior. Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Avoid the unsupported automatic step components so the guide prerenders and hydrates correctly. Co-authored-by: Cursor <cursoragent@cursor.com>
Document the maintained client, browser, and server test postures with verified examples and cleanup guidance. Co-authored-by: Cursor <cursoragent@cursor.com>
Keep jsdom in browser-mode installs so Vitest exits cleanly, and describe Solid 2 staged writes accurately. Co-authored-by: Cursor <cursoragent@cursor.com>
Keep the merged guides formatter-clean and align the sidebar transform with SolidBase's metadata-aware type. Co-authored-by: Cursor <cursoragent@cursor.com>
Improve safety, teaching order, migrations, and package-owned references before the Solid 2 release. Co-authored-by: Cursor <cursoragent@cursor.com>
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>
* docs: apply Solid 2 RC follow-ups * docs: remove component migration notes
Give React users and tooling a neutral semantic crosswalk so migrations follow Solid's execution, async, and composition models instead of translating APIs mechanically. Co-authored-by: Cursor <cursoragent@cursor.com>
|
|
✅ Deploy Preview for solid-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for solid-docs-v2 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Member
Author
|
Closing this PR: v2-rebuild remains an independent branch and is not intended to merge into main. |
Member
Author
|
For clarity: this PR was opened by the coding agent after it misinterpreted an instruction to “rebase and merge.” Ryan did not intend to merge |
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.
Summary
Test plan
pnpm check:typespnpm check:lintpnpm exec prettier . --checkpnpm lint:tone(0 errors; 11 existing generated-reference warnings)pnpm buildMade with Cursor