Skip to content

docs(devtools-ui-kit): mark package as deprecated - #1043

Merged
antfu merged 1 commit into
mainfrom
docs/deprecate-devtools-ui-kit
Jul 27, 2026
Merged

docs(devtools-ui-kit): mark package as deprecated#1043
antfu merged 1 commit into
mainfrom
docs/deprecate-devtools-ui-kit

Conversation

@antfubot

Copy link
Copy Markdown
Collaborator

Summary

Marks @nuxt/devtools-ui-kit as deprecated and stops encouraging new
adoption of it:

  • Add a deprecated field to packages/devtools-ui-kit/package.json.
  • Replace the WIP warning in the package README.md with a deprecation
    notice.
  • Add a deprecation callout to the /module/ui-kit docs page and drop
    the line recommending the Starter Template as the way to pull in the
    UI Kit for new module integrations.

Existing consumers are unaffected — no code, components, or the
module-starter playground dependency were touched.


Created with the help of an agent.

Add a deprecated field to package.json, update the package README, and
add a deprecation notice to the UI Kit docs page. Drop the recommendation
to build new module integrations on top of it via the starter template.
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying nuxt-devtools with  Cloudflare Pages  Cloudflare Pages

Latest commit: 48d04ad
Status: ✅  Deploy successful!
Preview URL: https://77a9a644.nuxt-devtools.pages.dev
Branch Preview URL: https://docs-deprecate-devtools-ui-k.nuxt-devtools.pages.dev

View logs

@antfu
antfu merged commit 71e93de into main Jul 27, 2026
5 of 7 checks passed
@antfu
antfu deleted the docs/deprecate-devtools-ui-kit branch July 27, 2026 06:32
@coderabbitai

coderabbitai Bot commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 9ec42b0d-4bde-4155-ad2f-135600301673

📥 Commits

Reviewing files that changed from the base of the PR and between 6eeec69 and 48d04ad.

📒 Files selected for processing (3)
  • docs/content/2.module/2.ui-kit.md
  • packages/devtools-ui-kit/README.md
  • packages/devtools-ui-kit/package.json

📝 Walkthrough

Walkthrough

The package metadata now declares @nuxt/devtools-ui-kit deprecated and links to the UI kit module documentation. The package README replaces its work-in-progress warning with deprecation guidance. The UI Kit module documentation adds a deprecation callout and removes the Starter Template recommendation from the installation section.

Estimated code review effort: 1 (Trivial) | ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: marking the devtools-ui-kit package as deprecated.
Description check ✅ Passed The description matches the changeset and accurately describes the deprecation updates across docs and package metadata.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/deprecate-devtools-ui-kit

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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