Skip to content

chore: update docs#1081

Merged
tenphi merged 11 commits intomainfrom
chore-update-docs
Mar 18, 2026
Merged

chore: update docs#1081
tenphi merged 11 commits intomainfrom
chore-update-docs

Conversation

@tenphi
Copy link
Copy Markdown
Member

@tenphi tenphi commented Mar 17, 2026

Note

Low Risk
Low risk: changes are limited to documentation/Storybook metadata plus an optional new audit script; no runtime component logic is modified.

Overview
Adds a new pnpm audit-docs tool (scripts/audit-docs.mjs) that uses the TypeScript Compiler API to compare resolved component props vs .docs.mdx “Properties” sections vs Storybook argTypes, with optional --fix-stories auto-updates and JSON/verbose output.

Updates many component .docs.mdx files to standardize/expand prop lists and base/field property references, and adjusts multiple .stories.tsx files to add/remove argTypes entries so Storybook controls/descriptions stay in sync with the docs.

Written by Cursor Bugbot for commit 0589fd7. This will update automatically on new commits. Configure here.

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Mar 17, 2026

⚠️ No Changeset found

Latest commit: 0589fd7

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Mar 17, 2026

📦 NPM canary release

Deployed canary version 0.0.0-canary-5fd053f.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Mar 17, 2026

🏋️ Size limit report

Name Size Passed?
All 362.77 KB (0% 🟰) Yes 🎉
Tree shaking (just a Button) 99.97 KB (0% 🟰) Yes 🎉

Click here if you want to find out what is changed in this build

Comment thread scripts/audit-docs.mjs Fixed
Comment thread scripts/audit-docs.mjs Fixed
Comment thread scripts/audit-docs.mjs Fixed
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Mar 17, 2026

🧪 Storybook is successfully deployed!

…ing or encoding

Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
@vercel
Copy link
Copy Markdown

vercel Bot commented Mar 17, 2026

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

Project Deployment Actions Updated (UTC)
cube-ui-kit Ready Ready Preview, Comment Mar 18, 2026 8:21am

Request Review

…ing or encoding

Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
Comment thread scripts/audit-docs.mjs Outdated
Comment thread scripts/audit-docs.mjs
Comment thread scripts/audit-docs.mjs
Copy link
Copy Markdown
Contributor

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

Bugbot Autofix prepared a fix for the issue found in the latest run.

  • ✅ Fixed: Map serializes as empty object in JSON output
    • Added a JSON replacer function that converts Map instances to plain objects using Object.fromEntries() before JSON serialization.

Create PR

Or push these changes by commenting:

@cursor push b72d2b3f50
Preview (b72d2b3f50)
diff --git a/scripts/audit-docs.mjs b/scripts/audit-docs.mjs
--- a/scripts/audit-docs.mjs
+++ b/scripts/audit-docs.mjs
@@ -766,7 +766,9 @@
   }
 
   if (jsonOutput) {
-    console.log(JSON.stringify(results, null, 2));
+    const replacer = (key, value) =>
+      value instanceof Map ? Object.fromEntries(value) : value;
+    console.log(JSON.stringify(results, replacer, 2));
   } else {
     const failed = results.filter((r) => !r.ok);
     const passed = results.filter((r) => r.ok);

This Bugbot Autofix run was free. To enable autofix for future PRs, go to the Cursor dashboard.

Comment thread scripts/audit-docs.mjs Outdated
@tenphi
Copy link
Copy Markdown
Member Author

tenphi commented Mar 18, 2026

@cursor push b72d2b3

@tenphi tenphi merged commit 9b20254 into main Mar 18, 2026
16 checks passed
@tenphi tenphi deleted the chore-update-docs branch March 18, 2026 08:28
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.

3 participants