docs: full rewrite of the docs site content against the skill canon#29
Merged
Conversation
intro/quick-start modernized (/{$}, URLFor links, lifecycle); new
concepts.md (vocabulary) and error-handling.md (buffering rules, typed
errors, Redirect signal, JSON form, SSE); routing gains {$}, wildcards,
param naming, page groups; supported-flows reframed as the four
response shapes; htmx rebuilt around the three-site loop, id scheme,
nested swap levels, and v4 selector; urlfor rewritten from scratch
(previous version documented non-existent APIs: Ref{Name}, URLForValidate,
positional []any params); middleware redirects via URLFor + HX-Location;
advanced fixes the type-alias section for strict mode.
api.md now covers Parse, all options (incl. WithMaxIDLength, WithURLPrefix), Init, the four ServeHTTP signatures, direct-vs- reflective RenderComponent, and the HTMXRenderTarget algorithm including the authoritative pass-0 real-id match and the htmx 4 selector. New lint.md documents all six check categories and suppression directives.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #29 +/- ##
=======================================
Coverage 94.66% 94.66%
=======================================
Files 15 15
Lines 1594 1594
=======================================
Hits 1509 1509
Misses 51 51
Partials 34 34 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
jackielii
added a commit
that referenced
this pull request
Jun 17, 2026
docs: full rewrite of the docs site content against the skill canon
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
1 participant
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
Full rewrite of
docs/*.md(the docs-site content source) following the audit that found factual errors, forbidden patterns, and missing coverage. Companion sidebar commit is already on thedocs-sitebranch (a8a1973).Corrections
Ref{Name: ...}struct literal,URLForValidate, positional[]anyparams,IDreturning CamelCase) and described strict mode incorrectlyHTMXv4RenderTarget,WithMaxIDLength,WithURLPrefix, andInitRenderComponent(target, args)→ constructed components;http.Redirect→Redirectsignal +HX-Location;http.Errorendorsements removed; hard-coded URLs →URLFor; ~25 discarded errors now handled;{id}→ specific param namesNew pages
ErrorWithStatus, theRedirectsignal, JSON endpoints, SSERestructured
/{$}andURLForlinks from the first exampleVerified
Docusaurus build passes locally with the new sidebar; no broken links or anchors from the rewritten pages (only pre-existing gomarkdoc anchor noise in the generated package reference).