Skip to content

docs: publish API docs for every package with doc-kit - #116

Merged
bnb merged 2 commits into
mainfrom
bnb/doc-kit
Oct 28, 2026
Merged

bnb merged 2 commits into
mainfrom
bnb/doc-kit

Conversation

@botandbang

Copy link
Copy Markdown
Contributor

Adds a documentation site built with doc-kit from docs/pages/: an index page and one reference page per package, with signatures, typed parameter tables, source links, search, llms.txt, a sitemap and JSON per page. The pages were checked against the source and correct a few things the READMEs had wrong: core's fetch default is globalThis.fetch, semver.major/minor/patch are numbers, security.oldest is now documented, fetchindex has no defaults, and opt and translate are marked as not yet on npm.

Each package README is now its description, install command and a link to its page, so the API is documented once. The root README links the site and lists the dev scripts. Adds npm run docs (build into out/) and npm run docs:dev (build and serve with sirv-cli), plus .github/workflows/docs.yml, which builds on PRs and deploys to GitHub Pages from main.

Three workarounds for serving from /nodevu/: pathsToCopy copies the page sources instead of doc-kit's default static/ (here the @nodevu/static workspace), docs/theme/Navigation.jsx points the logo at the index instead of /, and CI builds use absolute URLs so all.html and 404.html find their assets.

@socket-security

socket-security Bot commented Oct 28, 2026 •

Copy link
Copy Markdown

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff Package Supply Chain
Security
Vulnerability Quality Maintenance License
Addednpm/​sirv-cli@​3.0.19910010080100
Addednpm/​@​doc-kit/​cli@​1.0.5821008095100
Addednpm/​@​node-core/​ui-components@​1.8.1821008294100
Addednpm/​@​doc-kit/​generator-react@​0.5.0851008496100

View full report

@bnb
bnb merged commit 7de529c into main Oct 28, 2026
39 checks passed
@bnb
bnb deleted the bnb/doc-kit branch October 28, 2026 23:02
@nodevu-ci nodevu-ci Bot mentioned this pull request Oct 28, 2026
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.

2 participants