Skip to content

feat(docs): migrate to doc-kit#5438

Open
avivkeller wants to merge 3 commits into
nodejs:mainfrom
forked-by-avivkeller:docs
Open

feat(docs): migrate to doc-kit#5438
avivkeller wants to merge 3 commits into
nodejs:mainfrom
forked-by-avivkeller:docs

Conversation

@avivkeller

@avivkeller avivkeller commented Jun 17, 2026

Copy link
Copy Markdown
Member

Migrates the docs to use doc-kit

Demo: https://forked-by-avivkeller.github.io/undici/


Fixes: #3132
Fixes: #183
Fixes: #1205
Fixes: #1865
Closes: #2208

@avivkeller avivkeller changed the title [WIP] doc-kit feat(docs): migrate to doc-kit Jun 17, 2026
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.36%. Comparing base (a0806e1) to head (bae13a9).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #5438   +/-   ##
=======================================
  Coverage   93.36%   93.36%           
=======================================
  Files         110      110           
  Lines       36993    36993           
=======================================
  Hits        34537    34537           
  Misses       2456     2456           

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@avivkeller

Copy link
Copy Markdown
Member Author

cc @nodejs/undici @nodejs/web-infra

@mcollina

Copy link
Copy Markdown
Member

This is impressive, huge +1 for doc-kit!!

If you are up for it, I would slightly prefer to have a system to provide the docs for the various release lines.
When a release is cut, its docs are built and stored somewhere.

This is why I was thinking to use the other repo.

@avivkeller

Copy link
Copy Markdown
Member Author

No problem! We are working on a similar pipeline for webpack, so it shouldn't be too hard. However, you should note that the previous docs don't follow doc-kit structure, so older docs might not render 100% the same as newer docs.

Just to confirm, let's say I change this PR to only change the doc format to support doc-kit, and then a PR in the undici website repo to read the various tags and build a website around it?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

3 participants