Add new docs url to README

[bmuenzenmeyer]

Description

Simply adds the new docs site to the README for better discovery.

Validation

Related Issues

closes #936 now that #935 is landed

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.

[vercel]

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

Project	Deployment	Actions	Updated (UTC)
api-docs-tooling	Ready	Preview	Jul 31, 2026 12:13pm

[cursor]

PR Summary

Low Risk
Documentation-only README change with no runtime or security impact.

Overview
Adds a centered README blurb that doc-kit can power non–Node.js doc sites and links to https://doc-kit.nodejs.org/ for docs, getting started, and the showcase.

^{Reviewed by Cursor Bugbot for commit 891516e. Bugbot is set up for automated code reviews on this repo. Configure here.}

[Copilot]

Pull request overview

Updates the project README to surface the new documentation site for easier discovery, aligning with the request in issue #936.

Changes:

• Adds a centered README line linking to https://doc-kit.nodejs.org/ for docs/getting started/showcase.
• Splits the intro blurb into two centered paragraphs to include the new docs-site mention.

---

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

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.63%. Comparing base (0de5adf) to head (891516e).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #967   +/-   ##
=======================================
  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]

api-links Generator

Performance estimate _{(single CI run)}

• Generation time: 11.8% slower (1.52 s → 1.70 s)
• Peak memory: 0.7% lower (348.62 MB → 346.01 MB)

legacy-html Generator

Performance estimate _{(single CI run)}

• Generation time: 5.6% faster (19.43 s → 18.34 s)
• Peak memory: 1.7% lower (2.31 GB → 2.27 GB)

legacy-json Generator

Performance estimate _{(single CI run)}

• Generation time: 10.1% faster (10.21 s → 9.18 s)
• Peak memory: 4.8% lower (1.78 GB → 1.69 GB)

llms-txt Generator

Performance estimate _{(single CI run)}

• Generation time: 29.5% faster (8.91 s → 6.28 s)
• Peak memory: 0.0% lower (1.77 GB → 1.77 GB)

orama-db Generator

Performance estimate _{(single CI run)}

• Generation time: 3.1% faster (8.85 s → 8.58 s)
• Peak memory: 6.5% lower (1.82 GB → 1.70 GB)

web Generator

Output size: 3 files changed · net -194.00 B

File size details

File	Main	PR	Change
assets/all-BIn8xzRq.js	22.13 MB	—	-22.13 MB (-100.0%)
assets/all-CRWh3RMj.js	—	22.13 MB	+22.13 MB
all.html	21.37 MB	21.37 MB	-194.00 B (-0.0%)

Performance estimate _{(single CI run)}

• Generation time: 16.6% faster (75.82 s → 63.23 s)
• Peak memory: 1.5% lower (5.14 GB → 5.06 GB)

[Copilot]

Pull request overview

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

Suppressed comments (1)

README.md:16

• The link text "View the docs, getting-started, and showcase." reads awkwardly and uses a hyphenated phrase that isn't used elsewhere in the README. Consider using standard wording ("getting started") and articles to make the sentence grammatically clear.

  <code>doc-kit</code> can make sites unrelated to Node.js too. <a href="https://doc-kit.nodejs.org/">View the docs, getting-started, and showcase.</a>