GitShow/solidjs/solid-docs
solidjs

solid-docs

Official documentation for the Solid ecosystem

by solidjs
docsreactivitysignalssolidsolid-routersolid-startsolidjssolidrouter
Star on GitHubForkWebsite

MDX

289 stars362 forks273 contributorsActive · 6h agoSince 2022

Meet the team

See all 273 on GitHub →
LadyBluenotes
LadyBluenotes421 contributions
michaelessiet
michaelessiet210 contributions
Jutanium
Jutanium187 contributions
dependabot[bot]Bot
dependabot[bot]117 contributions
amirhhashemi
amirhhashemi97 contributions
atilafassina
atilafassina95 contributions
nas5w
nas5w77 contributions
danieljcafonso
danieljcafonso41 contributions

Languages

View on GitHub →
MDX84.1%
TypeScript11.2%
JavaScript3.9%
CSS0.7%

Commit activity

Last 12 weeks · 57 commits

Full graph →

Community health

4 of 6 standards met

Community profile →
87
✓README○License✓Contributing✓Code of Conduct○Issue Template✓PR Template

Recent PRs & issues

Active · Last activity 6h ago
See all on GitHub →
OneEyed1366
[Request]: Cover native/mobile rendering (`solid-js/universal`) - the docs have no answer to "can I build a mobile app with Solid?"OpenIssue

What is this request related to? Request 📋 Suggested https://docs.solidjs.com/quick-start https://docs.solidjs.com/reference/rendering/render (no existing page covers this — that's the point of the request) 📋 General description or bullet points The gap There is currently nothing in the docs about rendering Solid anywhere other than the DOM. A search across for , , , , and returns zero hits in . So: "Can I build a mobile app with Solid?" — a very common first question — has no answer in the docs. () is a public, shipped Solid API with no reference page and no mention anywhere in the docs. Right now you have to read in the Solid repo to learn it exists. Prior art in neighbouring frameworks Both Svelte and Vue answer this in their own docs, and both did it recently: Svelte — FAQ entry on mobile apps: https://github.com/sveltejs/svelte/pull/18665 (merged) Vue — https://github.com/vuejs/docs/pull/3452 (open) Each covers two distinct paths: wrapping an SPA (Capacitor / Tauri) and rendering real native views through a custom renderer. Concrete proposal A short page under Guides (e.g. "Building for mobile"), or an FAQ entry if you'd rather introduce one, covering: 1. Wrapping a Solid SPA — Capacitor (there are official ) and Tauri. 2. Real native views via — lets Solid drive a non-DOM host. Worth a paragraph on its own merit, independent of any particular library, since the API is undocumented today. Optionally a follow-up reference page for under . Disclosure + offer I maintain Symbiote Native, which has a adapter () driving React Native's Fabric renderer with React out of the path, running on device. So I have an obvious interest here and I'm flagging it up front. I'm happy to write the PR, and equally happy for it to name no specific library at all — the missing coverage of and of the mobile question stands either way. One data point on how thin the current coverage is: the only mobile-related entry on solidjs.com's resources page, , is flagged in 's own data. 🖥️ Reproduction of code samples in StackBlitz _No response_

OneEyed1366 · 3d ago
dongyikuan919
docs: explain signal object and array updatesOpenPR

[x] I have read the Contribution guide [x] This PR references an issue (except for typos, broken links, or other minor problems) Description(required) Document that directly mutating an object or array stored in a signal does not notify subscribers because the setter is not called. The new example shows updating through the setter with a new array and points readers who need frequent nested updates to stores. Related issues & labels Closes #1621 Suggested label(s) (optional): documentation Verification Reviewed the MDX against the repository writing guide. Prettier dependency installation could not complete locally; CI will run in the repository-required Node 24 environment.

dongyikuan919 · 4d ago
ryansolid
Document untrack behavior with uninitialized async reads (NotReady propagation)OpenIssue

From solidjs/solid#3007 (reported by @mizulu). The reference page (https://v2.solidjs.com/reference/solid-js/reactivity/untrack) should document how interacts with async reads in 2.0: stops dependency tracking — reads inside it do not subscribe the surrounding computation. It does not opt out of async settlement. Reading an async source that is not yet ready inside still throws , which propagates to the owning computation: the owner suspends (participates in boundaries) and re-runs once the source first resolves. In other words, where is a pending async memo will still cause the owner to re-run when first settles — the read is untracked, but the not-ready suspension is part of async graph resolution, not tracking. The page should spell out this distinction (tracking vs. settlement) and show the pattern for a genuinely non-suspending read of a possibly-pending source (e.g. checking readiness with / as appropriate) so users aren't surprised that alone doesn't provide a fallback-value escape hatch. A fallback-value overload for was considered in solidjs/solid#3007 and rejected — the docs are the fix.

ryansolid · 1w ago

Recent fixes

View closed PRs →
jer3m01
chore: delete solid v2 contentMergedPR

Removes Solid v2 content from the site, separate PR as grace period for the current content (merge in a few weeks?). Depends on #1623.

jer3m01 · 4d ago
fabian-hiller
Add schema validation example to SolidStart data mutation guideMergedPR

[x] I have read the Contribution guide [ ] This PR references an issue (except for typos, broken links, or other minor problems) Description(required) The data mutation guide validates form fields manually. This adds a short follow-up example to the "Validating form fields" section that uses Valibot as the schema validator, so readers see how to scale validation beyond a single field without leaving the action pattern. The example follows the existing TypeScript/JavaScript tab conventions and is type-checked. Happy to port it to the v1 guide as well if you want, and happy to open an issue first if you prefer that for additions like this. I'm the author of Valibot. Related issues & labels Suggested label(s) (optional): documentation

fabian-hiller · 4d ago
srxcode
[Content]: Conflicting documentation about A (Anchor)ClosedIssue

📚 Subject area/topic Routing & Navigation 📋 Page(s) affected (or suggested, for new content) https://docs.solidjs.com/guides/routing-and-navigation https://docs.solidjs.com/solid-router/reference/components/a 📋 Description of content that is out-of-date or incorrect The page for states the following: A will be deprecated in favor of the native element. However, there's a conflicting description in the routing and navigation page(step 6) , which is perhaps outdated. The component provides navigation to an application's routes. Alternatively, you can use the native anchor tag. However, the component provides additional functionality including properties for CSS, inactiveClass and activeClass. The code example given below the statement also uses the instead of the native tag 🖥️ Reproduction in StackBlitz (if reporting incorrect content or code samples) _No response_

srxcode · 5d ago
Structured data for AI agents

Repository: solidjs/solid-docs. Description: Official documentation for the Solid ecosystem Stars: 289, Forks: 362. Primary language: MDX. Languages: MDX (84.1%), TypeScript (11.2%), JavaScript (3.9%), CSS (0.7%). Homepage: https://docs.solidjs.com/ Topics: docs, reactivity, signals, solid, solid-router, solid-start, solidjs, solidrouter, solidstart. Open PRs: 5, open issues: 36. Last activity: 6h ago. Community health: 87%. Top contributors: LadyBluenotes, michaelessiet, Jutanium, dependabot[bot], amirhhashemi, atilafassina, nas5w, danieljcafonso, nksaraf, boehs and others.

·@ofershap

Replace github.com with gitshow.dev