Skip to content

fix: resolve broken links - #965

Merged
bmuenzenmeyer merged 2 commits into
mainfrom
broken-links
Jul 31, 2026
Merged

fix: resolve broken links#965
bmuenzenmeyer merged 2 commits into
mainfrom
broken-links

Conversation

@bmuenzenmeyer

@bmuenzenmeyer bmuenzenmeyer commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Description

Every single one of these is broken over on doc-kit.nodejs.org

Validation

Related Issues

Check List

  • I have read the Contributing Guidelines and made commit messages that follow the guideline.
  • I have run node --run test and all tests passed.
  • I have check code formatting with node --run format:check & node --run lint.
  • I've covered new added functionality with unit tests if necessary.

Copilot AI review requested due to automatic review settings July 31, 2026 02:15
@bmuenzenmeyer
bmuenzenmeyer requested a review from a team as a code owner July 31, 2026 02:15
@cursor

cursor Bot commented Jul 31, 2026

Copy link
Copy Markdown

PR Summary

Low Risk
Documentation-only link target changes with no runtime, build, or security impact.

Overview
Fixes broken navigation on doc-kit.nodejs.org by updating relative links in www/pages/index.md and www/pages/getting-started.md so they point at the generated .html pages instead of extensionless paths.

On the homepage, the generators reference, specification link, and “What’s next” list (getting started, commands, configuration, generators) now use ./…​.html. The getting-started “Next steps” links to configuration, the web generator guide, and the specification are updated the same way.

Reviewed by Cursor Bugbot for commit 74d3e72. Bugbot is set up for automated code reviews on this repo. Configure here.

@vercel

vercel Bot commented Jul 31, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
api-docs-tooling Ready Ready Preview Jul 31, 2026 2:21am

Request Review

@bmuenzenmeyer

Copy link
Copy Markdown
Contributor Author

When I contributed this, there was review feedback that they were not necessary. 🤷

@codecov

codecov Bot commented Jul 31, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.63%. Comparing base (b80958f) to head (74d3e72).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #965   +/-   ##
=======================================
  Coverage   86.63%   86.63%           
=======================================
  Files         195      195           
  Lines       17938    17938           
  Branches     1632     1632           
=======================================
  Hits        15540    15540           
  Misses       2392     2392           
  Partials        6        6           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@github-actions

github-actions Bot commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

api-links Generator

Performance estimate (single CI run)

  • Generation time: 472.7% slower (1.65 s → 9.45 s)
  • Peak memory: 1.9% lower (358.09 MB → 351.24 MB)

legacy-html Generator

Performance estimate (single CI run)

  • Generation time: 4.8% faster (20.13 s → 19.17 s)
  • Peak memory: 0.6% lower (2.42 GB → 2.40 GB)

legacy-json Generator

Performance estimate (single CI run)

  • Generation time: 14.9% faster (8.92 s → 7.59 s)
  • Peak memory: 0.1% higher (1.72 GB → 1.72 GB)

llms-txt Generator

Performance estimate (single CI run)

  • Generation time: 20.5% faster (8.38 s → 6.66 s)
  • Peak memory: 4.2% higher (1.80 GB → 1.87 GB)

orama-db Generator

Output size: 1 file changed · net +1.00 B

File size details
File Main PR Change
orama-db.json 8.89 MB 8.89 MB +1.00 B (+0.0%)

Performance estimate (single CI run)

  • Generation time: 6.1% slower (8.16 s → 8.66 s)
  • Peak memory: 3.0% lower (1.86 GB → 1.80 GB)

web Generator

Output size: 2 files changed · net 0 B

File size details
File Main PR Change
assets/all-CrZzA5_i.js 22.13 MB -22.13 MB (-100.0%)
assets/all-FOceAO_p.js 22.13 MB +22.13 MB

Performance estimate (single CI run)

  • Generation time: 25.3% slower (59.78 s → 74.92 s)
  • Peak memory: 1.3% lower (5.25 GB → 5.18 GB)

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the doc-kit documentation site’s narrative Markdown pages to link to the generated .html outputs, resolving broken internal navigation on doc-kit.nodejs.org.

Changes:

  • Update internal relative links in www/pages/index.md to point to *.html targets.
  • Update “Next steps” links in www/pages/getting-started.md to point to *.html targets.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
www/pages/index.md Converts internal doc links to explicit .html targets for the generated site output.
www/pages/getting-started.md Converts “Next steps” internal links to explicit .html targets for correct navigation.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

@avivkeller

Copy link
Copy Markdown
Member

Can't you enable .html -> / forwarding?

@bmuenzenmeyer

Copy link
Copy Markdown
Contributor Author

Can't you enable .html -> / forwarding?

I dunno, can I? I don't know what layer of the stack this is being suggested for 😄 - making the code just more accurate feels easier. This is broken right now, we should fix it.

@bmuenzenmeyer

bmuenzenmeyer commented Jul 31, 2026

Copy link
Copy Markdown
Contributor Author

this is broken and should be fixed - merging - if someone wants to fast-follow with something more elegant, 👍

@bmuenzenmeyer
bmuenzenmeyer merged commit 0de5adf into main Jul 31, 2026
27 checks passed
@bmuenzenmeyer
bmuenzenmeyer deleted the broken-links branch July 31, 2026 02:50
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.

3 participants