fix(docs): version-picker shows selected option on /versions/latest/ - #187
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the DocFX site’s version-picker.js so the version dropdown correctly shows a selected option when viewing documentation under /versions/latest/, by removing a dead “resolve latest to concrete version” block and adjusting how the latest alias is handled during option rendering.
Changes:
- Removed a URL-based “latest resolution” block that could never match due to structural URL differences.
- Adjusted dropdown rendering logic and comments around when to include/skip the
latestalias.
Copilot on #187 flagged that `currentVersion` defaulted to `'latest'` on non-versioned pages (site root, docs pages, etc.), and the skip predicate `v.version === 'latest' && currentVersion !== 'latest'` therefore didn't fire on those pages either — surfacing `latest` in the picker outside of `/versions/latest/`, which contradicts the PR intent. Change the default from the string `'latest'` to `null`. Now: - On `/versions/latest/` currentVersion === 'latest' → `latest` included, `latest` option selected. - On `/versions/v0.2.1/` currentVersion === 'v0.2.1' → `latest` skipped, v0.2.1 option selected. - On non-versioned pages currentVersion === null → `latest` skipped, no option pre-selected. The `if (v.version === currentVersion)` selection line still works — `v.version === null` is always false, so no spurious selection on non-versioned pages. Updated the inline comment to describe the new starts-null semantics. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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