Repository navigation
docs: add a needs-review page flag and edit the densest pages - #1706
Merged
Merged
Conversation
Adds a `review: wanted` frontmatter flag that shows a note at the top of the page asking for edits. Flags five pages with the densest drafting jargon, and cuts From React from 6,589 to about 2,050 words. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0117BoWLqMnD77CVCXUp3bTh
|
|
✅ Deploy Preview for solid-docs-v2 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Replaces drafting jargon (held answers, lands, settled view) with plain descriptions, cuts repetition, renames three headings and updates every link to them, including the reference generator. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0117BoWLqMnD77CVCXUp3bTh
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0117BoWLqMnD77CVCXUp3bTh
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0117BoWLqMnD77CVCXUp3bTh
Also drops a stale claim that Loading compares `on` by identity: the expression is tracked and its value does not matter, so an array works, as the other pages and the Loading reference say. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0117BoWLqMnD77CVCXUp3bTh
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0117BoWLqMnD77CVCXUp3bTh
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0117BoWLqMnD77CVCXUp3bTh
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0117BoWLqMnD77CVCXUp3bTh
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0117BoWLqMnD77CVCXUp3bTh
…hor) Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0117BoWLqMnD77CVCXUp3bTh
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0117BoWLqMnD77CVCXUp3bTh
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)
Responds to #1650. Instead of a badge on every page, this adds a flag for pages that still read as drafts, and edits the pages that needed it most.
Page flag
review: wanted. When it is set, the page opens with a note, "This page needs an editorial pass", plus the existing edit and report-an-issue links (osmium/src/ui/review-wanted.tsx,docs-layout.tsx,frontmatter.ts).Edited pages
I picked these by the density of drafting jargon per 1,000 words of prose ("held", "lands", "its next answer", "slot", "seam") and by length. There is one commit per page so each can be reviewed alone.
Fixes found along the way
Loadingcomparesonvalues by identity, so "use a string, not an array". TheLoadingJSDoc says the expression is tracked and its value does not matter, which is also what the other pages say. I removed the claim and changed the example to an array.scripts/extract-solid-ref.mjsand the generatedis-pending,erroredandon-flushreference pages./routing/solid-router/data#show-what-is-happening(linked from From Solid Router) pointed to a heading that no longer exists. It now points to#read-results-with-usesubmissions.Checks:
lint:tone,check:types,check:lint,prettier --check .andvite buildall pass. I also ran a script against the build: all 213 in-site#anchorlinks resolve. I did not runcheck:examples, because it needs local checkouts.Related issues & labels
🤖 Generated with Claude Code
https://claude.ai/code/session_0117BoWLqMnD77CVCXUp3bTh