Skip to content

refactor(react): extract @doc-kittens/react package - #959

Open
avivkeller wants to merge 1 commit into
refactor/specifier-loadingfrom
refactor/react-kitten
Open

refactor(react): extract @doc-kittens/react package#959
avivkeller wants to merge 1 commit into
refactor/specifier-loadingfrom
refactor/react-kitten

Conversation

@avivkeller

@avivkeller avivkeller commented Jul 30, 2026

Copy link
Copy Markdown
Member

The React/JSX-based generators (html, renamed from web), jsx-ast, llms-txt, sitemap, and orama-db have moved into the new @doc-kittens/react package, and are loaded via import specifiers such as @doc-kittens/react/html.

To avoid breaking existing CLIs, the html generator can be referred to by the web specifier.

@vercel

vercel Bot commented Jul 30, 2026

Copy link
Copy Markdown

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

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

Request Review

@avivkeller
avivkeller marked this pull request as ready for review July 30, 2026 21:33
@avivkeller
avivkeller requested a review from a team as a code owner July 30, 2026 21:33
Copilot AI review requested due to automatic review settings July 30, 2026 21:33
@cursor

cursor Bot commented Jul 30, 2026

Copy link
Copy Markdown

PR Summary

High Risk
Major packaging and naming change: consumers must use the new package/specifiers and html config keys; incorrect installs or stale web config could break doc builds, though aliases and registry tests mitigate CLI breakage.

Overview
Introduces @doc-kittens/react and moves the JSX-oriented generators (html, jsx-ast, llms-txt, sitemap, orama-db) out of @node-core/doc-kit. Core’s generator registry now resolves those targets to @doc-kittens/react/* import specifiers instead of in-package paths, and drops the corresponding package.json exports and heavy UI/Vite/Preact dependencies from core.

The former web generator is renamed to html: config and generator name use html, while web remains a deprecated CLI/config alias via a new deprecatedGenerators map and tests that still load it. The Recma/JSX remark pipeline (getRemarkRecma) moves from core remark.mjs into packages/react/src/jsx-ast/utils/remark.mjs; core keeps only the HTML-oriented remark pipelines.

Moved code imports shared utilities from @node-core/doc-kit (config, metadata types, highlighter, etc.). ESLint browser overrides and scripts/vercel-build.sh switch from web to html. Changeset: major for @doc-kittens/react, minor for @node-core/doc-kit.

Reviewed by Cursor Bugbot for commit 316965a. Bugbot is set up for automated code reviews on this repo. Configure here.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

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