Title: fix(docs): normalize path separators in the content build on Windows by mofopeadegoke · Pull Request #10067 · simstudioai/sim · GitHub
Open Graph Title: fix(docs): normalize path separators in the content build on Windows by mofopeadegoke · Pull Request #10067 · simstudioai/sim
X Title: fix(docs): normalize path separators in the content build on Windows by mofopeadegoke · Pull Request #10067 · simstudioai/sim
Description: Summary On Windows, path.relative in apps/docs/scripts/compile-content.ts returns backslash-separated paths. Navigation keys and page URLs are built from that value (e.g. /introduction\index), so they never match the forward-slash entries in meta.json, and content:generate fails with Navigation /meta.json references missing page ./introduction/index. That also breaks docs type-check and the repo's pre-push hook on Windows. This normalizes the relative path to / once, where it's created. On macOS and Linux path.sep is already /, so it's a no-op there. One file, +2 / −1. Fixes #10066 Product update (if relevant) N/A: developer tooling. Contributors on Windows can build the docs, run type-check, and push without --no-verify. Type of Change Bug fix New feature Breaking change Documentation Other: ___________ Testing On Windows 11 (Bun 1.4.4, Node 24.22.3), in apps/docs: bun run content:generate: failed before (references missing page ./introduction/index); passes now (Catalog ready: 829 pages). bun run type-check (content generation, next typegen, tsc): passes. bun run content:verify-compatibility: passes against scripts/fixtures/content-baseline.json with 0 lost routes, 0 lost anchors and 0 changed code fences across 829 pages, so the generated URLs on Windows now match the baseline. bun run test: passes. Biome: passes. Pre-push hook: with this fix, lint:check and the docs type-check pass on Windows. The hook's parallel type-check still ran out of memory in @sim/app on my 15 GB machine (unrelated to this change; it passes with tsc --noEmit --singleThreaded), so I pushed with --no-verify. Related: #9400 fixes the same separator issue in two scripts/check-*.ts audits; this covers the docs build, which that PR doesn't touch. Checklist Code follows project style guidelines Self-reviewed my changes Tests added/updated and passing (existing docs tests and the compatibility check pass; no new test, since CI runs on Linux, where this path is a no-op) No new warnings introduced I confirm that I have read and agree to the terms outlined in the Contributor License Agreement (CLA) Screenshots/Videos N/A (terminal output in #10066).
Open Graph Description: Summary On Windows, path.relative in apps/docs/scripts/compile-content.ts returns backslash-separated paths. Navigation keys and page URLs are built from that value (e.g. /introduction\index), so t...
X Description: Summary On Windows, path.relative in apps/docs/scripts/compile-content.ts returns backslash-separated paths. Navigation keys and page URLs are built from that value (e.g. /introduction\index), so t...
Opengraph URL: https://github.com/simstudioai/sim/pull/10067
X: @github
Domain: github.com
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /:user_id/:repository/pull/:id/files(.:format) |
| route-controller | pull_requests |
| route-action | files |
| fetch-nonce | v2:f073dd6a-549f-a891-9a3f-fb5f9dfa9a06 |
| current-catalog-service-hash | ae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b |
| request-id | 942E:7C051:1BD2108:25EC45B:6AFB99E5 |
| html-safe-nonce | 471819ae282e6ec41ba2416ce7ab1e6043beb19f7140388ffed86e0cb3ba66d7 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5NDJFOjdDMDUxOjFCRDIxMDg6MjVFQzQ1Qjo2QUZCOTlFNSIsInZpc2l0b3JfaWQiOiIyNTk0NTUxNTgwMjI5MDgxNTczIiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | b750e567809c9ea14abf77bc0bc9576fa6a88c2fb9dae35dce28bb8307a2251a |
| hovercard-subject-tag | pull_request:5319139413 |
| github-keyboard-shortcuts | repository,pull-request-list,pull-request-conversation,pull-request-files-changed,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/simstudioai/sim/pull/10067/files |
| twitter:image | https://avatars.githubusercontent.com/u/110726038?s=400&v=4 |
| twitter:card | summary_large_image |
| og:image | https://avatars.githubusercontent.com/u/110726038?s=400&v=4 |
| og:image:alt | Summary On Windows, path.relative in apps/docs/scripts/compile-content.ts returns backslash-separated paths. Navigation keys and page URLs are built from that value (e.g. /introduction\index), so t... |
| og:site_name | GitHub |
| og:type | object |
| hostname | github.com |
| expected-hostname | github.com |
| None | 3cefd19a936819d82cfb5279d50fb56fe79cb9ec30f0f807e04e89b0c58ffae1 |
| turbo-cache-control | no-preview |
| diff-view | unified |
| go-import | github.com/simstudioai/sim git https://github.com/simstudioai/sim.git |
| octolytics-dimension-user_id | 199344406 |
| octolytics-dimension-user_login | simstudioai |
| octolytics-dimension-repository_id | 912559512 |
| octolytics-dimension-repository_nwo | simstudioai/sim |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 912559512 |
| octolytics-dimension-repository_network_root_nwo | simstudioai/sim |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | true |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 606800bdb1b81d125fc845bdcc262c9fe063fc8f |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width