Skip to content

Add ShadCN catalog collection metadata - #99

Merged
tannerlinsley merged 1 commit into
mainfrom
taren/shadcn-docs-collection
Aug 14, 2026
Merged

Add ShadCN catalog collection metadata#99
tannerlinsley merged 1 commit into
mainfrom
taren/shadcn-docs-collection

Conversation

@tannerlinsley

@tannerlinsley tannerlinsley commented Aug 14, 2026

Copy link
Copy Markdown
Member

Summary

  • mark the 70 official ShadCN chart cases and dashboard as one catalog collection
  • add the collection to Charts docs navigation under Examples
  • validate collection membership while generating the catalog index
  • record and resolve the absolute-link tab inference friction

Validation

  • pnpm validate
  • 188 catalog previews regenerated and validated
  • local visual audit against tanstack.com collection and detail routes

Summary by CodeRabbit

  • New Features

    • Added shadcn/ui Charts to Chart Guides navigation.
    • Added shadcn collection labels to dashboard and chart examples.
    • Shadcn examples now remain visible and active when accessed through the catalog.
  • Bug Fixes

    • Fixed navigation behavior for direct links to the shadcn chart collection.
  • Tests

    • Added validation coverage for chart collection metadata and invalid catalog references.

@coderabbitai

coderabbitai Bot commented Aug 14, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 65237c4f-46e7-4cce-8f2b-a553f97e400d

📥 Commits

Reviewing files that changed from the base of the PR and between b7b3f0f and 405e18a.

📒 Files selected for processing (7)
  • API-FRICTION.md
  • benchmarks/conformance/catalog-index.json
  • benchmarks/conformance/previews/manifest.json
  • docs/config.json
  • packages/charts-core/docs/config.json
  • scripts/catalog-index.mjs
  • scripts/catalog-index.test.mjs

📝 Walkthrough

Walkthrough

The change adds validated ShadCN collection metadata to catalog generation and conformance entries. It also adds ShadCN Charts links to both documentation navigation configurations and records the resolved Examples-tab navigation issue.

Changes

ShadCN catalog integration

Layer / File(s) Summary
Catalog collection generation and validation
scripts/catalog-index.mjs, scripts/catalog-index.test.mjs
The index generator reads ShadCN case mappings, validates collection IDs and case references, and adds collection metadata to matching entries. Tests cover valid and invalid mappings.
Generated catalog metadata
benchmarks/conformance/catalog-index.json, benchmarks/conformance/previews/manifest.json
ShadCN catalog entries now include collection: "shadcn". The preview manifest uses an updated sourceHash.
Chart navigation and issue record
docs/config.json, packages/charts-core/docs/config.json, API-FRICTION.md
Both Chart Guides configurations link to the ShadCN collection and select the examples tab. The resolved navigation issue is documented.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Merge Risk: ⚪ Minimal · up to 405e1

This catalog metadata and documentation navigation change is merge-ready after normal checks and review; no actionable merge-blocking risk remains.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the primary change: adding ShadCN catalog collection metadata.
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 💡 1
📝 Generate docstrings 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch taren/shadcn-docs-collection

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.

@nx-cloud

nx-cloud Bot commented Aug 14, 2026

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit 405e18a

Command Status Duration Result
nx run charts-workspace:ci-distributed ✅ Succeeded 1m 36s View ↗
nx run charts-workspace:package-check ✅ Succeeded <1s View ↗
nx run charts-workspace:benchmark-check ✅ Succeeded <1s View ↗

☁️ Nx Cloud last updated this comment at 2026-08-14 16:06:26 UTC

@tannerlinsley
tannerlinsley merged commit f2d662a into main Aug 14, 2026
12 checks passed
@tannerlinsley
tannerlinsley deleted the taren/shadcn-docs-collection branch August 14, 2026 16:10
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.

1 participant