Skip to content

build(doc): redirect legacy API docs index to documentation page#63496

Open
ubay1 wants to merge 1 commit into
nodejs:mainfrom
ubay1:fix/build-doc
Open

build(doc): redirect legacy API docs index to documentation page#63496
ubay1 wants to merge 1 commit into
nodejs:mainfrom
ubay1:fix/build-doc

Conversation

@ubay1
Copy link
Copy Markdown

@ubay1 ubay1 commented May 22, 2026

Description

Configure legacy API docs generation to redirect the generated index.html
landing page to documentation.html by using the new
--index-redirect-url option provided by doc-kit.

This improves the API docs landing experience by directing users to the
actual documentation content instead of the generated index overview page.

Validation

  • Generated legacy API docs locally
  • Verified that index.html redirects to documentation.html
  • Verified behavior works correctly with and without trailing slashes
  • Confirmed other legacy API pages remain unchanged

Related Issues

Fixes #60667 nodejs/doc-kit#808

@nodejs-github-bot nodejs-github-bot added build Issues and PRs related to build files or the CI. needs-ci PRs that need a full CI run. labels May 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

build Issues and PRs related to build files or the CI. needs-ci PRs that need a full CI run.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Render "About this documentation" as the landing page for the documentation section

2 participants