Repository navigation
docs: publish API docs for every package with doc-kit - #116
Merged
Merged
Conversation
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
bnb
approved these changes
Oct 28, 2026
Draft
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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'sfetchdefault isglobalThis.fetch,semver.major/minor/patchare numbers,security.oldestis now documented,fetchindexhas no defaults, andoptandtranslateare 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 intoout/) andnpm 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/:pathsToCopycopies the page sources instead of doc-kit's defaultstatic/(here the@nodevu/staticworkspace),docs/theme/Navigation.jsxpoints the logo at the index instead of/, and CI builds use absolute URLs soall.htmland404.htmlfind their assets.