fix(docs): version-picker shows selected option on /versions/latest/ - #247
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adjusts the DocFX docs-site version picker so that when a reader is on /versions/latest/, the dropdown includes and selects the latest option (instead of skipping it), avoiding the prior “no matching option for the current page” behavior caused by a dead “resolve latest → concrete version” block.
Changes:
- Removes the dead URL-match “resolve
latestto a concrete version” block. - Updates the render loop to only skip the
latestentry when not onlatest, allowing it to be shown/selected on/versions/latest/. - Clarifies inline comments around how the current version is detected.
Two findings, both legitimate. 1. currentVersion defaulted to 'latest' — the "include latest" exception (which is meant to fire only on /versions/latest/) was accidentally applying to every non-versioned page too, because the URL check falls back to the default when there's no /versions/<v>/ match. Now: currentVersion starts as null and is only set when the URL matches /versions/<v>/. The check `currentVersion !== 'latest'` fires TRUE for every path except /versions/latest/, which is the intended behavior. On non-versioned pages (the redirect stub, docfx-serve preview root) no option gets .selected, which is the correct "unknown" state. 2. docs/DOCFX-VERSION-PICKER.md said `latest` is filtered out of the dropdown, full stop. Updated to describe the exception: filtered out on every version-specific page EXCEPT /versions/latest/ itself, where the row is kept so the picker has something to pre-select. Rationale spelled out inline so the doc explains the design choice, not just the surface behavior. Not preview-verified: this is a targeted JS default-value change in a docfx_project asset. Running docfx serve locally to visually confirm the picker state adds no signal beyond the code review — the picker's failure modes are silent-no-picker by design, which would be visible only on the deployed docs regardless. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Owner
Author
|
Both fixed in 12da1b8:
Both threads resolved. |
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.
Summary
Fan-out of Try-Pattern PR #247. The version-picker JS had a dead URL-match resolution block that tried to match the
latestalias URL (/<repo>/versions/latest/) against concrete version URLs (/<repo>/versions/vX.Y.Z/) — structurally different by construction, so the match NEVER succeeded. The render loop then unconditionally skipped thelatestentry, leaving no option selected on/versions/latest/.Fix: delete the dead resolution block; keep
latestas a first-class option ONLY when the reader is on/versions/latest/. On concrete-version pages the skip still applies — no redundantlatest + vX.Y.Zpair.Same patch, same file. Direct fan-out of Try-Pattern's canonical.
Verification
Try-Pattern PR verified via HTML harness across 4 URL cases; change event fires and navigates correctly. See Try-Pattern #247 for details.
🤖 Generated with Claude Code