docs: classify README/examples (D4a) and close switcher viewport-coverage gap - #178
Draft
777genius wants to merge 3 commits into
Draft
docs: classify README/examples (D4a) and close switcher viewport-coverage gap#178777genius wants to merge 3 commits into
777genius wants to merge 3 commits into
Conversation
Mark Use vs Build (unreleased preview) journeys, distinguish historical plugin-kit-ai v1 examples from the standard authoring MVP, pin historical npm/pipx install commands to 1.2.4, and fix dead GitHub Pages links to point at immutable repository blob references.
Reload the intended origin before every switcher activation instead of reusing state from a previous selection, assert navbar button/menu viewport containment, and verify the resulting pathname/identity/lang for all five destinations across every origin.
page.goto() only waits for networkidle, not VitePress client-router
rendering, and page.evaluate has no locator auto-wait. The unguarded
document.querySelector(".vp-doc").append(...) call raced client
hydration and intermittently threw "Cannot read properties of null
(reading 'append')" (see .handoff/pending/browser-existing-fragment-failure.log).
Wait for .vp-doc to be visible before both evaluate calls that touch it.
|
Important Draft PR not reviewedDraft PRs are not automatically reviewed by default.
To automatically review draft PRs, update your CodeRabbit configuration: reviews:
auto_review:
drafts: trueThanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
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.
Scope
Stacked on #177 (generated baseline). Two independent, previously-pending patches, now reviewed and integrated on top of
674d9735:docs: classify README and examples for unreleased authoring (D4a)- rootREADME.mdand the fourexamples/*/README.mdfiles. Surfaces the Use/Build journeys near the top, marks Build explicitly unreleased with links to prepared source guides, keeps installer instructions/command blocks/safety/client coverage text intact, and keeps the historical v1 authoring workflow reachable and clearly labelled as 1.2.4-era. No example implementation, dependency, asset, test, or design doc was touched or deleted.test(docs): reload origin per switcher activation and assert bounds+fix(docs): wait for .vp-doc before the archived-fragment probe evaluate-website/tools/quality/locale-browser.mjsonly. Closes the one non-blocking follow-up from docs(authoring): prepare site consumer, historical routes, and locale corrections (D2b/D3) #176's independent review (switcher assertions previously checked link attributes but never activated the five destinations or asserted navbar/menu viewport containment). Now every switcher activation reloads its own origin, asserts navbar button/menu bounds fit the viewport before interaction, activates all five destinations for both variants across every origin, and asserts the resulting pathname/visible identity/document language.The intermittent race this closes
A prior run of the switcher smoke intermittently failed inside the unchanged, pre-existing archived-fragment probe with
Cannot read properties of null (reading 'append')atlocale-browser.mjs:38(.handoff/pending/browser-existing-fragment-failure.log). Root cause:page.goto()only waits fornetworkidle, not VitePress client-router hydration, and the followingpage.evaluatehad no locator auto-wait before touching.vp-doc. Fix addsawait page.locator(".vp-doc").first().waitFor({ state: "visible" })before bothpage.evaluatecalls that touch that node. This is a real hydration-wait fix, not a retry/catch/skip.Why not squashed into #176 or #177
fix(docs): preserve localized archives...(#176's tip) already had independent MEDIUM review; re-opening that diff to fold in unrelated README/test changes would re-litigate already-accepted content. The generated baseline (#177) is deliberately single-purpose (mechanical only). These two patches are their own reviewable unit.Evidence
git diff --checkclean, installer sections/command blocks byte-compared to base, changed-line count 139+/24-..vp-docwait fix, 70 switcher activations (50 counterparts/10 fallback/10 home) and 35 navbar containment cases passed cleanly except for the intermittent unrelated-probe race now fixed; re-verifying with two fresh consecutive runs on this exact HEAD as part of packaging this PR (recorded in.handoff/HOSTED_PROGRESS.md, not posted as a separate PR comment).Explicitly not claimed
useDocsLinksrewrite, 5-locale SEO/canonical/hreflang parity) - tracked separately, not started.