fix(docs): normalize sidebar path separators for Windows - #2405
Draft
sidsri14 wants to merge 1 commit into
Draft
Conversation
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.
Fixes #2402: building the docs sidebar on Windows fails with
Cannot read properties of undefined (reading 'toLowerCase')becausepath.relativereturns backslash-separated paths on Windows, sourl.split('/')[1](the category) is undefined.What changed
packages/docs/sidebars.js: normalize the doc-relative path to forward slashes (\\→/) before category extraction and doc-ID construction, via a smallrelativeDocUrlhelper. The generated doc IDs remain forward-slash paths on all platforms.packages/docs/sidebars.test.js(Node's built-innode:testrunner, no new dependencies) and atestscript for@temporalio/docs. The tests cover forward-slash, Windows-style, and multi-dot basename inputs. CI'spnpm run testruns onwindows-x64too, so this is a real regression test for the affected platform.Verification
node --test packages/docs/sidebars.test.js→ 3/3 pass.prettier --checkclean on all changed files.docusaurus buildrequires a dependency install and POSIX shell for thebuild-docsenv assignments, so it wasn't run locally; the bug reproduces purely in sidebar generation, which the unit tests exercise.AI disclosure
Code authored with the assistance of an AI coding agent.