Skip to content

docs: unslop pass over Learn pages and tutorials - #1685

Draft
brenelz wants to merge 1 commit into
v2-rebuildfrom
docs/unslop-pass
Draft

brenelz wants to merge 1 commit into
v2-rebuildfrom
docs/unslop-pass

Conversation

@brenelz

@brenelz brenelz commented Nov 3, 2026 •

Copy link
Copy Markdown
Collaborator

Follows #1683 with a second prose pass over the Learn pages (getting started, concepts, building apps, routing, guides, migration, glossary) and the tutorial lessons. Reference pages are not touched; most of them are generated from the Solid JSDoc.

The pass used the unslop skill's rules in docs register, with WRITING.md winning where they disagree. It removed these patterns:

  • "X, not Y" constructions and staged colon reveals ("The fix is structural:", "What it costs:")
  • sentences where a page describes itself ("This page covers...", "Most apps need the first two sections...")
  • metaphors in the verb slot ("ride the same hold", "is the gate", "earns its place") and inanimate things with a will ("Nothing on the server asks...")
  • slogan lines and closing sayings ("The URL is the API", "Later wins.")
  • counts that carry no information
  • em dashes in prose (all 10 in the solid-meta migration page)
  • 21 contractions in the tutorial lessons

Headings, code blocks, links, frontmatter, callouts and the Recap and Next steps sections are unchanged. About 15 pages already read clean and have no edits. No edit adds a fact; each rewrite keeps the original claim at the same strength.

This is a WIP draft. Each page's owner should read their own diff, since a few sentences were reworded around claims that need a source check.

Verification

  • pnpm lint:tone: 0 errors. The one warning is in a generated reference page.
  • Every changed .mdx file compiles with @mdx-js/mdx and remark-frontmatter.
  • I reviewed the diff for dropped or changed claims and corrected 9 of them. codex exec review --base origin/v2-rebuild found no regressions.
  • The full vite build has not been run.

Open questions for page owners

These came up during the pass and were left unchanged:

  • The testing guide's recap says to keep jsdom installed in browser mode, but the body never teaches this, and the browser-mode install command leaves jsdom out.
  • The Rendering and SSR opener shows ReferenceError: window is not defined, but the next sentence says the module read localStorage.
  • Durable generation says to write "every few tens of milliseconds, as the example does", but the start() code on the page writes on every chunk.
  • The Components and JSX and TypeScript openers start with a definition or a description of the page, not a concrete situation as WRITING.md asks.
  • Choose a rendering mode states how Google and other crawlers run JavaScript without a source.
  • Lists says the pattern above "is what those libraries build on" about virtualizers, with nothing on the page to back it.

🤖 Generated with Claude Code

@bolt-new-by-stackblitz

Copy link
Copy Markdown

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@netlify

netlify Bot commented Nov 3, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for solid-docs-v2 ready!

Name Link
🔨 Latest commit 1254976
🔍 Latest deploy log https://app.netlify.com/projects/solid-docs-v2/deploys/6aea34afcb25f39c617f8bda
😎 Deploy Preview https://deploy-preview-1685--solid-docs-v2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant