Conversation
Bare relative links like `[AsyncTests](AsyncTests)` resolved to `/docs/AsyncTests` instead of `/docs/benchmarks/AsyncTests`. Use `./Name.md` form so Docusaurus resolves to the sibling route. Fixes #5585
There was a problem hiding this comment.
Code Review
Overall: Clean, minimal, correct fix. Approved.
What the PR does
Bare Markdown links like [AsyncTests](AsyncTests) in Docusaurus are resolved relative to the site root, producing /docs/AsyncTests (404). Switching to ./AsyncTests.md instructs Docusaurus to resolve relative to the current file's directory, yielding the correct /docs/benchmarks/AsyncTests route.
Assessment
The change is correct and well-scoped:
- Root cause addressed — both generator scripts (
process-benchmarks.js,process-mock-benchmarks.js) are updated, so CI regenerations will preserve the fix rather than reverting it. - Generated files regenerated —
index.mdandmocks/index.mdare committed in the same PR, keeping the repo consistent immediately. - No over-engineering — the minimal
./Name.mdform is the canonical Docusaurus recommendation for relative sibling links; nothing more is needed.
Minor observation (non-blocking)
Both generator scripts still produce a trailing blank line between the runtime benchmarks list and the "Build Benchmarks" section (the template literal leaves a double newline). This is a pre-existing cosmetic quirk unrelated to this fix and not worth changing here.
No issues found. This is a straightforward, correct documentation fix.
Up to standards ✅🟢 Issues
|
| Metric | Results |
|---|---|
| Complexity | 0 |
TIP This summary will be updated as you push new changes. Give us feedback
Summary
/docs/benchmarks/index resolved to/docs/<Name>(404) instead of/docs/benchmarks/<Name>../<Name>.mdso Docusaurus resolves to the sibling route.process-benchmarks.js,process-mock-benchmarks.js) and regeneratedindex.mdfiles so CI regenerations keep the fix.Fixes #5585
Test plan
https://tunit.dev/docs/benchmarks/point to/docs/benchmarks/AsyncTestsetc./docs/benchmarks/mocks/resolve correctly.