feat(docs): migrate to doc-kit

[avivkeller]

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

[codecov-commenter]

Codecov Report

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

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #5438   +/-   ##
=======================================
  Coverage   93.44%   93.44%           
=======================================
  Files         110      110           
  Lines       37078    37078           
=======================================
  Hits        34649    34649           
  Misses       2429     2429           

☔ 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]

cc @nodejs/undici @nodejs/web-infra

[mcollina]

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]

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?

[avivkeller]

@mcollina in order for the site to update, on this repo's release, it needs to trigger a rebuild there, however, the GITHUB_TOKEN doesn't have cross repo permissions. Any ideas?