Skip to content

docs: fix relative links broken by the README move - #5843

Open
v1teka wants to merge 1 commit into
nodejs:mainfrom
v1teka:fix/docs-relative-links
Open

v1teka wants to merge 1 commit into
nodejs:mainfrom
v1teka:fix/docs-relative-links

Conversation

@v1teka

@v1teka v1teka commented Sep 20, 2026

Copy link
Copy Markdown

docs/docs/index.md is the former repository-root README, so its links are still written relative to the repo root: ./docs/docs/api/... now resolves to docs/docs/docs/docs/api/..., and ./CONTRIBUTING.md and ./docs/examples/README.md no longer resolve at all. The in-tree links are now relative to docs/docs/, and the two targets outside the doc-kit tree use absolute GitHub URLs so they work both on GitHub and on the published site.

docs/README.md pointed at ./site.json and ./type-map.json, which live one level down in docs/docs/.

This relates to...

Rationale

Changes

Features

Bug Fixes

Breaking Changes and Deprecations

Status

docs/docs/index.md is the former repository-root README, so its links
are still written relative to the repo root: ./docs/docs/api/... now
resolves to docs/docs/docs/docs/api/..., and ./CONTRIBUTING.md and
./docs/examples/README.md no longer resolve at all. The in-tree links
are now relative to docs/docs/, and the two targets outside the
doc-kit tree use absolute GitHub URLs so they work both on GitHub and
on the published site.

docs/README.md pointed at ./site.json and ./type-map.json, which live
one level down in docs/docs/.

Signed-off-by: v1teka <29147256+v1teka@users.noreply.github.com>
@v1teka
v1teka force-pushed the fix/docs-relative-links branch from 0106972 to c8e7127 Compare September 20, 2026 10:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant