Repository navigation
docs: voice pass to cut generated-sounding prose - #1683
Merged
Merged
Conversation
Rewrite the openers of all 19 guides to say what the page is for instead of staging a scene, drop 'This guide goes through...' signposts and announced counts, split the densest option catalogs (Performance tracks, Observability, Debugging reactivity), remove size-suite numbers, and use common contractions in prose (not headings, so anchors stay stable). WRITING.md: allow common contractions, discourage scene-setting openers, and list the patterns this pass removed under 'Patterns that read as generated'. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0117BoWKzrkGqR2qnNqNfyqo
|
|
✅ Deploy Preview for solid-docs-v2 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
…uting Same treatment as the guides: openers say what the page is for instead of staging a scene, signposts and dense one-sentence catalogs split up, common contractions in prose (headings unchanged so anchors stay). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0117BoWKzrkGqR2qnNqNfyqo
ryansolid
changed the title
Revert the WRITING.md changes and the contractions: WRITING.md is the docs team's guide. Restore a concrete situation before definitions in the openers that had become definition-first (Stores, Async reactivity, Boundaries, Server functions, Routing overview, Solid Router intro, Route definitions, Custom primitives). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0117BoWKzrkGqR2qnNqNfyqo
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
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.
Requested by Ryan · project thread
Description(required)
An editing pass over the hand-written 2.0 pages (the guides, Getting started, Concepts, Building apps including Server functions, and Routing) so they read less like generated text, within the rules in
WRITING.md. Code blocks are unchanged, and technical claims and links are kept except where noted.WRITING.mditself is not changed.WRITING.mdasks, but gets to what the page covers in one or two sentences.enablePerformanceTracks(label shortening,Server-Timingmapping,minMs/rich/values) now lives only in its reference page, which the guide links.Suspense/createResourcein its intro.The third commit reverts an earlier attempt at contractions and at
WRITING.mdedits, so the net diff has neither.Checks:
pnpm lint:tonegives 0 errors. Prettier is clean. No code blocks changed, socheck:exampleswasn't re-run.Not touched: Migration pages, Glossary, Reference, tutorials.
Related issues & labels
🤖 Generated with Claude Code
https://claude.ai/code/session_0117BoWKzrkGqR2qnNqNfyqo