docs(swingset): add Mosaic component documentation guidance - #8886

Merged
kylemac merged 1 commit into
mainfrom
kylemac/swingset-agents-md
Jun 17, 2026
Merged

docs(swingset): add Mosaic component documentation guidance#8886
kylemac merged 1 commit into
mainfrom
kylemac/swingset-agents-md

Conversation

@kylemac

@kylemackylemac commented Jun 17, 2026•
edited
Loading

Copy link
Copy Markdown
Contributor

TLDR

  • adds a bit more guidance around how we should document the various mosaic layers in swingset
  • cleans up a few instances where we ran afoul
  • adds a "default" column to our props table so its easier to see what the defaults are for each prop

Description

Adds a house style to packages/swingset/CLAUDE.md for documenting Mosaic components consistently: the six layers, three doc archetypes (simple vs. compound styled components, headless primitives, and composed layers), meta/story conventions, and a default-value convention. Brings the existing components into line with it — the auto-generated <PropTable> now renders a dedicated Default column (instead of inlining the default into the type), Composition.tsx gains the missing Panels layer in its ordering, and the OrganizationProfile and Destructive pages get their missing composition lists. Documentation/tooling only for the private, unpublished @clerk/swingset package, so an empty changeset is included. To test: run pnpm run dev:swingset and confirm component pages render with a clean type column plus a separate Default column, and that composed pages show their composition footers.

Checklist

  • pnpm test runs as expected.
  • pnpm build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

Summary by CodeRabbit

  • New Features

    • Added a Default column to the property table for clearer visibility of component default values.

  • Documentation

    • Updated development documentation with comprehensive component documentation guidelines, including conventions for layers, metadata, and MDX section ordering.
    • Refreshed dev command guidance.

  • Chores

    • Reorganized component layer ordering and updated story compositions.

@kylemac
docs(swingset): add Mosaic component documentation guidance
0d36a73
Document the house style for component docs in CLAUDE.md: the six layers,
three archetypes (simple/compound styled components, headless primitives,
composed layers), meta conventions, and a default-value convention. Add a
Default column to the auto-generated PropTable and backfill missing
composition lists so existing components follow the guidance.
@changeset-bot

changeset-botBot commented Jun 17, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 0d36a73

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 0 packages

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

Not sure what this means? Click here to learn what changesets are.

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

@vercel

vercelBot commented Jun 17, 2026•
edited
Loading

Copy link
Copy Markdown

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

ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJun 17, 2026 1:07am
swingsetReadyReadyPreview, CommentJun 17, 2026 1:07am

Request Review

@coderabbitai

coderabbitaiBot commented Jun 17, 2026•
edited
Loading

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

Adds a dedicated Default column to PropTable (splitting it from the Value column), inserts a Panels entry into Composition's LAYER_ORDER, populates composition props in the destructive and organization-profile MDX stories, and substantially expands CLAUDE.md with Mosaic component documentation archetypes and a pre-submission checklist.

Changes

Swingset UI and documentation improvements

Layer / File(s)Summary
PropTable: separate Default and Value columns
packages/swingset/src/components/PropTable.tsx		Adds a Default column header; Default cell renders row.default in <code> or an em dash; Value cell now only renders a KnobControl or em dash, no longer falls back to row.default.
Composition: insert Panels into LAYER_ORDER
packages/swingset/src/components/Composition.tsx		LAYER_ORDER gains a Panels entry between AIO and Sections, updating layerRank() results and CompositionPanel group sort order.
MDX stories: add composition props
packages/swingset/src/stories/destructive.mdx, packages/swingset/src/stories/organization-profile.mdx		destructive.mdx Default story gains a composition array for Button, Input, and Dialog; organization-profile.mdx replaces its prior single-view setup with OrganizationProfileGeneral + Tabs and updates description text.
CLAUDE.md: Mosaic documentation conventions and changeset
packages/swingset/CLAUDE.md, .changeset/swingset-docs-guidance.md		Fixes dev command typo; adds house-style section defining layer groups, meta fields, Archetype A/B/C MDX section orders, and a before-you-finish checklist. Changeset entry tracks the update.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • clerk/javascript#8805: Both PRs modify packages/swingset/CLAUDE.md — the earlier PR initially establishes swingset agent guidance and this PR extends it with Mosaic component documentation archetypes.
  • clerk/javascript#8822: Both PRs modify packages/swingset/src/components/PropTable.tsx within the same component, with the earlier PR styling prop names using a Badge and this PR splitting Default from Value columns.

Suggested reviewers

  • alexcarpenter

🐇 A new column for defaults, hooray!
The Panels layer found its place today.
Stories now name each composed part,
And CLAUDE.md holds the doc-writing art.
Hop hop, the swingset swings just right! 🌟

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check nameStatusExplanationResolution
Docstring Coverage⚠️ WarningDocstring 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 nameStatusExplanation
Title check✅ PassedThe pull request title accurately summarizes the main change: adding Mosaic component documentation guidance to swingset, which is the primary objective and most substantial change in CLAUDE.md.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch

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

@pkg-pr-new

pkg-pr-newBot commented Jun 17, 2026

Copy link
Copy Markdown

Open in StackBlitz

@clerk/astro

npm i https://pkg.pr.new/@clerk/astro@8886

@clerk/backend

npm i https://pkg.pr.new/@clerk/backend@8886

@clerk/chrome-extension

npm i https://pkg.pr.new/@clerk/chrome-extension@8886

@clerk/clerk-js

npm i https://pkg.pr.new/@clerk/clerk-js@8886

@clerk/expo

npm i https://pkg.pr.new/@clerk/expo@8886

@clerk/expo-passkeys

npm i https://pkg.pr.new/@clerk/expo-passkeys@8886

@clerk/express

npm i https://pkg.pr.new/@clerk/express@8886

@clerk/fastify

npm i https://pkg.pr.new/@clerk/fastify@8886

@clerk/hono

npm i https://pkg.pr.new/@clerk/hono@8886

@clerk/localizations

npm i https://pkg.pr.new/@clerk/localizations@8886

@clerk/nextjs

npm i https://pkg.pr.new/@clerk/nextjs@8886

@clerk/nuxt

npm i https://pkg.pr.new/@clerk/nuxt@8886

@clerk/react

npm i https://pkg.pr.new/@clerk/react@8886

@clerk/react-router

npm i https://pkg.pr.new/@clerk/react-router@8886

@clerk/shared

npm i https://pkg.pr.new/@clerk/shared@8886

@clerk/tanstack-react-start

npm i https://pkg.pr.new/@clerk/tanstack-react-start@8886

@clerk/testing

npm i https://pkg.pr.new/@clerk/testing@8886

@clerk/ui

npm i https://pkg.pr.new/@clerk/ui@8886

@clerk/upgrade

npm i https://pkg.pr.new/@clerk/upgrade@8886

@clerk/vue

npm i https://pkg.pr.new/@clerk/vue@8886

commit: 0d36a73

@kylemac
kylemac merged commit 3b146a1 into mainJun 17, 2026
49 checks passed
@kylemac
kylemac deleted the kylemac/swingset-agents-md branch June 17, 2026 01:15
@coderabbitaicoderabbitaiBot mentioned this pull request Jun 17, 2026
Merged
9 tasks
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@alexcarpenteralexcarpenteralexcarpenter approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@kylemac@alexcarpenter
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
docs(swingset): add Mosaic component documentation guidance - #8886
Merged
kylemac merged 1 commit into
mainfrom 
kylemac/swingset-agents-md
Jun 17, 2026
Merged
docs(swingset): add Mosaic component documentation guidance#8886
kylemac merged 1 commit into
mainfrom 
kylemac/swingset-agents-md
Conversation
@kylemac
@kylemackylemac
commented
Jun 17, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
TLDR
  • adds a bit more guidance around how we should document the various mosaic layers in swingset
  • cleans up a few instances where we ran afoul
  • adds a "default" column to our props table so its easier to see what the defaults are for each prop
Description
Adds a house style to packages/swingset/CLAUDE.md for documenting Mosaic components consistently: the six layers, three doc archetypes (simple vs. compound styled components, headless primitives, and composed layers), meta/story conventions, and a default-value convention. Brings the existing components into line with it — the auto-generated <PropTable> now renders a dedicated Default column (instead of inlining the default into the type), Composition.tsx gains the missing Panels layer in its ordering, and the OrganizationProfile and Destructive pages get their missing composition lists. Documentation/tooling only for the private, unpublished @clerk/swingset package, so an empty changeset is included. To test: run pnpm run dev:swingset and confirm component pages render with a clean type column plus a separate Default column, and that composed pages show their composition footers.
Checklist
  • pnpm test runs as expected.
  • pnpm build runs as expected.
  •  (If applicable) JSDoc comments have been added or updated for any package exports
  •  (If applicable) Documentation has been updated
Type of change
  •  🐛 Bug fix
  •  🌟 New feature
  •  🔨 Breaking change
  •  📖 Refactoring / dependency upgrade / documentation
  •  other:
Summary by CodeRabbit
  • New Features
    • Added a Default column to the property table for clearer visibility of component default values.
  • Documentation
    • Updated development documentation with comprehensive component documentation guidelines, including conventions for layers, metadata, and MDX section ordering.
    • Refreshed dev command guidance.
  • Chores
    • Reorganized component layer ordering and updated story compositions.
@kylemac
docs(swingset): add Mosaic component documentation guidance
0d36a73
Document the house style for component docs in CLAUDE.md: the six layers,
three archetypes (simple/compound styled components, headless primitives,
composed layers), meta conventions, and a default-value convention. Add a
Default column to the auto-generated PropTable and backfill missing
composition lists so existing components follow the guidance.
@changeset-bot
changeset-botBot
commented
Jun 17, 2026

Copy link


Copy Markdown

🦋 Changeset detected
Latest commit: 0d36a73
The changes in this PR will be included in the next version bump.
This PR includes changesets to release 0 packages
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
Not sure what this means? Click here to learn what changesets are.
Click here if you're a maintainer who wants to add another changeset to this PR
@vercel
vercelBot
commented
Jun 17, 2026•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJun 17, 2026 1:07am
swingsetReadyReadyPreview, CommentJun 17, 2026 1:07am
Request Review
@coderabbitai
coderabbitaiBot
commented
Jun 17, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Review Change Stack
📝 Walkthrough
Walkthrough
Adds a dedicated Default column to PropTable (splitting it from the Value column), inserts a Panels entry into Composition's LAYER_ORDER, populates composition props in the destructive and organization-profile MDX stories, and substantially expands CLAUDE.md with Mosaic component documentation archetypes and a pre-submission checklist.
Changes
Swingset UI and documentation improvements
Layer / File(s)Summary
PropTable: separate Default and Value columns
packages/swingset/src/components/PropTable.tsx		Adds a Default column header; Default cell renders row.default in <code> or an em dash; Value cell now only renders a KnobControl or em dash, no longer falls back to row.default.
Composition: insert Panels into LAYER_ORDER
packages/swingset/src/components/Composition.tsx		LAYER_ORDER gains a Panels entry between AIO and Sections, updating layerRank() results and CompositionPanel group sort order.
MDX stories: add composition props
packages/swingset/src/stories/destructive.mdx, packages/swingset/src/stories/organization-profile.mdx		destructive.mdx Default story gains a composition array for Button, Input, and Dialog; organization-profile.mdx replaces its prior single-view setup with OrganizationProfileGeneral + Tabs and updates description text.
CLAUDE.md: Mosaic documentation conventions and changeset
packages/swingset/CLAUDE.md, .changeset/swingset-docs-guidance.md		Fixes dev command typo; adds house-style section defining layer groups, meta fields, Archetype A/B/C MDX section orders, and a before-you-finish checklist. Changeset entry tracks the update.
Estimated code review effort
🎯 2 (Simple) | ⏱️ ~10 minutes
Possibly related PRs
  • clerk/javascript#8805: Both PRs modify packages/swingset/CLAUDE.md — the earlier PR initially establishes swingset agent guidance and this PR extends it with Mosaic component documentation archetypes.
  • clerk/javascript#8822: Both PRs modify packages/swingset/src/components/PropTable.tsx within the same component, with the earlier PR styling prop names using a Badge and this PR splitting Default from Value columns.
Suggested reviewers
  • alexcarpenter
🐇 A new column for defaults, hooray!

The Panels layer found its place today.

Stories now name each composed part,

And CLAUDE.md holds the doc-writing art.

Hop hop, the swingset swings just right! 🌟
🚥 Pre-merge checks | ✅ 4 | ❌ 1
❌ Failed checks (1 warning)
Check nameStatusExplanationResolution
Docstring Coverage⚠️ WarningDocstring 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 nameStatusExplanation
Title check✅ PassedThe pull request title accurately summarizes the main change: adding Mosaic component documentation guidance to swingset, which is the primary objective and most substantial change in CLAUDE.md.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
✏️ Tip: You can configure your own custom pre-merge checks in the settings.
✨ Finishing Touches
📝 Generate docstrings
  •  Create stacked PR
  •  Commit on current branch
Comment @coderabbitai help to get the list of available commands and usage tips.
@pkg-pr-new
pkg-pr-newBot
commented
Jun 17, 2026

Copy link


Copy Markdown

Open in StackBlitz
@clerk/astro
npm i https://pkg.pr.new/@clerk/astro@8886

@clerk/backend
npm i https://pkg.pr.new/@clerk/backend@8886

@clerk/chrome-extension
npm i https://pkg.pr.new/@clerk/chrome-extension@8886

@clerk/clerk-js
npm i https://pkg.pr.new/@clerk/clerk-js@8886

@clerk/expo
npm i https://pkg.pr.new/@clerk/expo@8886

@clerk/expo-passkeys
npm i https://pkg.pr.new/@clerk/expo-passkeys@8886

@clerk/express
npm i https://pkg.pr.new/@clerk/express@8886

@clerk/fastify
npm i https://pkg.pr.new/@clerk/fastify@8886

@clerk/hono
npm i https://pkg.pr.new/@clerk/hono@8886

@clerk/localizations
npm i https://pkg.pr.new/@clerk/localizations@8886

@clerk/nextjs
npm i https://pkg.pr.new/@clerk/nextjs@8886

@clerk/nuxt
npm i https://pkg.pr.new/@clerk/nuxt@8886

@clerk/react
npm i https://pkg.pr.new/@clerk/react@8886

@clerk/react-router
npm i https://pkg.pr.new/@clerk/react-router@8886

@clerk/shared
npm i https://pkg.pr.new/@clerk/shared@8886

@clerk/tanstack-react-start
npm i https://pkg.pr.new/@clerk/tanstack-react-start@8886

@clerk/testing
npm i https://pkg.pr.new/@clerk/testing@8886

@clerk/ui
npm i https://pkg.pr.new/@clerk/ui@8886

@clerk/upgrade
npm i https://pkg.pr.new/@clerk/upgrade@8886

@clerk/vue
npm i https://pkg.pr.new/@clerk/vue@8886

commit: 0d36a73
@kylemac
kylemac
merged commit 3b146a1
into
mainJun 17, 2026

49 checks passed

@kylemac
kylemac
deleted the

kylemac/swingset-agents-md

branch
June 17, 2026 01:15
@coderabbitaicoderabbitaiBot
mentioned this pull request
Jun 17, 2026
 Merged

9 tasks
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@alexcarpenteralexcarpenteralexcarpenter approved these changes

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

2 participants

@kylemac@alexcarpenter

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
docs(swingset): add Mosaic component documentation guidance - #8886
Merged
kylemac merged 1 commit into
mainfrom 
kylemac/swingset-agents-md
Jun 17, 2026
Merged
docs(swingset): add Mosaic component documentation guidance#8886
kylemac merged 1 commit into
mainfrom 
kylemac/swingset-agents-md
Conversation
@kylemac
@kylemackylemac
commented
Jun 17, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
TLDR
  • adds a bit more guidance around how we should document the various mosaic layers in swingset
  • cleans up a few instances where we ran afoul
  • adds a "default" column to our props table so its easier to see what the defaults are for each prop
Description
Adds a house style to packages/swingset/CLAUDE.md for documenting Mosaic components consistently: the six layers, three doc archetypes (simple vs. compound styled components, headless primitives, and composed layers), meta/story conventions, and a default-value convention. Brings the existing components into line with it — the auto-generated <PropTable> now renders a dedicated Default column (instead of inlining the default into the type), Composition.tsx gains the missing Panels layer in its ordering, and the OrganizationProfile and Destructive pages get their missing composition lists. Documentation/tooling only for the private, unpublished @clerk/swingset package, so an empty changeset is included. To test: run pnpm run dev:swingset and confirm component pages render with a clean type column plus a separate Default column, and that composed pages show their composition footers.
Checklist
  • pnpm test runs as expected.
  • pnpm build runs as expected.
  •  (If applicable) JSDoc comments have been added or updated for any package exports
  •  (If applicable) Documentation has been updated
Type of change
  •  🐛 Bug fix
  •  🌟 New feature
  •  🔨 Breaking change
  •  📖 Refactoring / dependency upgrade / documentation
  •  other:
Summary by CodeRabbit
  • New Features
    • Added a Default column to the property table for clearer visibility of component default values.
  • Documentation
    • Updated development documentation with comprehensive component documentation guidelines, including conventions for layers, metadata, and MDX section ordering.
    • Refreshed dev command guidance.
  • Chores
    • Reorganized component layer ordering and updated story compositions.
@kylemac
docs(swingset): add Mosaic component documentation guidance
0d36a73
Document the house style for component docs in CLAUDE.md: the six layers,
three archetypes (simple/compound styled components, headless primitives,
composed layers), meta conventions, and a default-value convention. Add a
Default column to the auto-generated PropTable and backfill missing
composition lists so existing components follow the guidance.
@changeset-bot
changeset-botBot
commented
Jun 17, 2026

Copy link


Copy Markdown

🦋 Changeset detected
Latest commit: 0d36a73
The changes in this PR will be included in the next version bump.
This PR includes changesets to release 0 packages
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
Not sure what this means? Click here to learn what changesets are.
Click here if you're a maintainer who wants to add another changeset to this PR
@vercel
vercelBot
commented
Jun 17, 2026•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJun 17, 2026 1:07am
swingsetReadyReadyPreview, CommentJun 17, 2026 1:07am
Request Review
@coderabbitai
coderabbitaiBot
commented
Jun 17, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Review Change Stack
📝 Walkthrough
Walkthrough
Adds a dedicated Default column to PropTable (splitting it from the Value column), inserts a Panels entry into Composition's LAYER_ORDER, populates composition props in the destructive and organization-profile MDX stories, and substantially expands CLAUDE.md with Mosaic component documentation archetypes and a pre-submission checklist.
Changes
Swingset UI and documentation improvements
Layer / File(s)Summary
PropTable: separate Default and Value columns
packages/swingset/src/components/PropTable.tsx		Adds a Default column header; Default cell renders row.default in <code> or an em dash; Value cell now only renders a KnobControl or em dash, no longer falls back to row.default.
Composition: insert Panels into LAYER_ORDER
packages/swingset/src/components/Composition.tsx		LAYER_ORDER gains a Panels entry between AIO and Sections, updating layerRank() results and CompositionPanel group sort order.
MDX stories: add composition props
packages/swingset/src/stories/destructive.mdx, packages/swingset/src/stories/organization-profile.mdx		destructive.mdx Default story gains a composition array for Button, Input, and Dialog; organization-profile.mdx replaces its prior single-view setup with OrganizationProfileGeneral + Tabs and updates description text.
CLAUDE.md: Mosaic documentation conventions and changeset
packages/swingset/CLAUDE.md, .changeset/swingset-docs-guidance.md		Fixes dev command typo; adds house-style section defining layer groups, meta fields, Archetype A/B/C MDX section orders, and a before-you-finish checklist. Changeset entry tracks the update.
Estimated code review effort
🎯 2 (Simple) | ⏱️ ~10 minutes
Possibly related PRs
  • clerk/javascript#8805: Both PRs modify packages/swingset/CLAUDE.md — the earlier PR initially establishes swingset agent guidance and this PR extends it with Mosaic component documentation archetypes.
  • clerk/javascript#8822: Both PRs modify packages/swingset/src/components/PropTable.tsx within the same component, with the earlier PR styling prop names using a Badge and this PR splitting Default from Value columns.
Suggested reviewers
  • alexcarpenter
🐇 A new column for defaults, hooray!

The Panels layer found its place today.

Stories now name each composed part,

And CLAUDE.md holds the doc-writing art.

Hop hop, the swingset swings just right! 🌟
🚥 Pre-merge checks | ✅ 4 | ❌ 1
❌ Failed checks (1 warning)
Check nameStatusExplanationResolution
Docstring Coverage⚠️ WarningDocstring 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 nameStatusExplanation
Title check✅ PassedThe pull request title accurately summarizes the main change: adding Mosaic component documentation guidance to swingset, which is the primary objective and most substantial change in CLAUDE.md.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
✏️ Tip: You can configure your own custom pre-merge checks in the settings.
✨ Finishing Touches
📝 Generate docstrings
  •  Create stacked PR
  •  Commit on current branch
Comment @coderabbitai help to get the list of available commands and usage tips.
@pkg-pr-new
pkg-pr-newBot
commented
Jun 17, 2026

Copy link


Copy Markdown

Open in StackBlitz
@clerk/astro
npm i https://pkg.pr.new/@clerk/astro@8886

@clerk/backend
npm i https://pkg.pr.new/@clerk/backend@8886

@clerk/chrome-extension
npm i https://pkg.pr.new/@clerk/chrome-extension@8886

@clerk/clerk-js
npm i https://pkg.pr.new/@clerk/clerk-js@8886

@clerk/expo
npm i https://pkg.pr.new/@clerk/expo@8886

@clerk/expo-passkeys
npm i https://pkg.pr.new/@clerk/expo-passkeys@8886

@clerk/express
npm i https://pkg.pr.new/@clerk/express@8886

@clerk/fastify
npm i https://pkg.pr.new/@clerk/fastify@8886

@clerk/hono
npm i https://pkg.pr.new/@clerk/hono@8886

@clerk/localizations
npm i https://pkg.pr.new/@clerk/localizations@8886

@clerk/nextjs
npm i https://pkg.pr.new/@clerk/nextjs@8886

@clerk/nuxt
npm i https://pkg.pr.new/@clerk/nuxt@8886

@clerk/react
npm i https://pkg.pr.new/@clerk/react@8886

@clerk/react-router
npm i https://pkg.pr.new/@clerk/react-router@8886

@clerk/shared
npm i https://pkg.pr.new/@clerk/shared@8886

@clerk/tanstack-react-start
npm i https://pkg.pr.new/@clerk/tanstack-react-start@8886

@clerk/testing
npm i https://pkg.pr.new/@clerk/testing@8886

@clerk/ui
npm i https://pkg.pr.new/@clerk/ui@8886

@clerk/upgrade
npm i https://pkg.pr.new/@clerk/upgrade@8886

@clerk/vue
npm i https://pkg.pr.new/@clerk/vue@8886

commit: 0d36a73
@kylemac
kylemac
merged commit 3b146a1
into
mainJun 17, 2026

49 checks passed

@kylemac
kylemac
deleted the

kylemac/swingset-agents-md

branch
June 17, 2026 01:15
@coderabbitaicoderabbitaiBot
mentioned this pull request
Jun 17, 2026
 Merged

9 tasks
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@alexcarpenteralexcarpenteralexcarpenter approved these changes

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

2 participants

@kylemac@alexcarpenter

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
docs(swingset): add Mosaic component documentation guidance - #8886
Merged
kylemac merged 1 commit into
mainfrom 
kylemac/swingset-agents-md
Jun 17, 2026
Merged
docs(swingset): add Mosaic component documentation guidance#8886
kylemac merged 1 commit into
mainfrom 
kylemac/swingset-agents-md
Conversation
@kylemac
@kylemackylemac
commented
Jun 17, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
TLDR
  • adds a bit more guidance around how we should document the various mosaic layers in swingset
  • cleans up a few instances where we ran afoul
  • adds a "default" column to our props table so its easier to see what the defaults are for each prop
Description
Adds a house style to packages/swingset/CLAUDE.md for documenting Mosaic components consistently: the six layers, three doc archetypes (simple vs. compound styled components, headless primitives, and composed layers), meta/story conventions, and a default-value convention. Brings the existing components into line with it — the auto-generated <PropTable> now renders a dedicated Default column (instead of inlining the default into the type), Composition.tsx gains the missing Panels layer in its ordering, and the OrganizationProfile and Destructive pages get their missing composition lists. Documentation/tooling only for the private, unpublished @clerk/swingset package, so an empty changeset is included. To test: run pnpm run dev:swingset and confirm component pages render with a clean type column plus a separate Default column, and that composed pages show their composition footers.
Checklist
  • pnpm test runs as expected.
  • pnpm build runs as expected.
  •  (If applicable) JSDoc comments have been added or updated for any package exports
  •  (If applicable) Documentation has been updated
Type of change
  •  🐛 Bug fix
  •  🌟 New feature
  •  🔨 Breaking change
  •  📖 Refactoring / dependency upgrade / documentation
  •  other:
Summary by CodeRabbit
  • New Features
    • Added a Default column to the property table for clearer visibility of component default values.
  • Documentation
    • Updated development documentation with comprehensive component documentation guidelines, including conventions for layers, metadata, and MDX section ordering.
    • Refreshed dev command guidance.
  • Chores
    • Reorganized component layer ordering and updated story compositions.
@kylemac
docs(swingset): add Mosaic component documentation guidance
0d36a73
Document the house style for component docs in CLAUDE.md: the six layers,
three archetypes (simple/compound styled components, headless primitives,
composed layers), meta conventions, and a default-value convention. Add a
Default column to the auto-generated PropTable and backfill missing
composition lists so existing components follow the guidance.
@changeset-bot
changeset-botBot
commented
Jun 17, 2026

Copy link


Copy Markdown

🦋 Changeset detected
Latest commit: 0d36a73
The changes in this PR will be included in the next version bump.
This PR includes changesets to release 0 packages
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
Not sure what this means? Click here to learn what changesets are.
Click here if you're a maintainer who wants to add another changeset to this PR
@vercel
vercelBot
commented
Jun 17, 2026•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJun 17, 2026 1:07am
swingsetReadyReadyPreview, CommentJun 17, 2026 1:07am
Request Review
@coderabbitai
coderabbitaiBot
commented
Jun 17, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Review Change Stack
📝 Walkthrough
Walkthrough
Adds a dedicated Default column to PropTable (splitting it from the Value column), inserts a Panels entry into Composition's LAYER_ORDER, populates composition props in the destructive and organization-profile MDX stories, and substantially expands CLAUDE.md with Mosaic component documentation archetypes and a pre-submission checklist.
Changes
Swingset UI and documentation improvements
Layer / File(s)Summary
PropTable: separate Default and Value columns
packages/swingset/src/components/PropTable.tsx		Adds a Default column header; Default cell renders row.default in <code> or an em dash; Value cell now only renders a KnobControl or em dash, no longer falls back to row.default.
Composition: insert Panels into LAYER_ORDER
packages/swingset/src/components/Composition.tsx		LAYER_ORDER gains a Panels entry between AIO and Sections, updating layerRank() results and CompositionPanel group sort order.
MDX stories: add composition props
packages/swingset/src/stories/destructive.mdx, packages/swingset/src/stories/organization-profile.mdx		destructive.mdx Default story gains a composition array for Button, Input, and Dialog; organization-profile.mdx replaces its prior single-view setup with OrganizationProfileGeneral + Tabs and updates description text.
CLAUDE.md: Mosaic documentation conventions and changeset
packages/swingset/CLAUDE.md, .changeset/swingset-docs-guidance.md		Fixes dev command typo; adds house-style section defining layer groups, meta fields, Archetype A/B/C MDX section orders, and a before-you-finish checklist. Changeset entry tracks the update.
Estimated code review effort
🎯 2 (Simple) | ⏱️ ~10 minutes
Possibly related PRs
  • clerk/javascript#8805: Both PRs modify packages/swingset/CLAUDE.md — the earlier PR initially establishes swingset agent guidance and this PR extends it with Mosaic component documentation archetypes.
  • clerk/javascript#8822: Both PRs modify packages/swingset/src/components/PropTable.tsx within the same component, with the earlier PR styling prop names using a Badge and this PR splitting Default from Value columns.
Suggested reviewers
  • alexcarpenter
🐇 A new column for defaults, hooray!

The Panels layer found its place today.

Stories now name each composed part,

And CLAUDE.md holds the doc-writing art.

Hop hop, the swingset swings just right! 🌟
🚥 Pre-merge checks | ✅ 4 | ❌ 1
❌ Failed checks (1 warning)
Check nameStatusExplanationResolution
Docstring Coverage⚠️ WarningDocstring 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 nameStatusExplanation
Title check✅ PassedThe pull request title accurately summarizes the main change: adding Mosaic component documentation guidance to swingset, which is the primary objective and most substantial change in CLAUDE.md.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
✏️ Tip: You can configure your own custom pre-merge checks in the settings.
✨ Finishing Touches
📝 Generate docstrings
  •  Create stacked PR
  •  Commit on current branch
Comment @coderabbitai help to get the list of available commands and usage tips.
@pkg-pr-new
pkg-pr-newBot
commented
Jun 17, 2026

Copy link


Copy Markdown

Open in StackBlitz
@clerk/astro
npm i https://pkg.pr.new/@clerk/astro@8886

@clerk/backend
npm i https://pkg.pr.new/@clerk/backend@8886

@clerk/chrome-extension
npm i https://pkg.pr.new/@clerk/chrome-extension@8886

@clerk/clerk-js
npm i https://pkg.pr.new/@clerk/clerk-js@8886

@clerk/expo
npm i https://pkg.pr.new/@clerk/expo@8886

@clerk/expo-passkeys
npm i https://pkg.pr.new/@clerk/expo-passkeys@8886

@clerk/express
npm i https://pkg.pr.new/@clerk/express@8886

@clerk/fastify
npm i https://pkg.pr.new/@clerk/fastify@8886

@clerk/hono
npm i https://pkg.pr.new/@clerk/hono@8886

@clerk/localizations
npm i https://pkg.pr.new/@clerk/localizations@8886

@clerk/nextjs
npm i https://pkg.pr.new/@clerk/nextjs@8886

@clerk/nuxt
npm i https://pkg.pr.new/@clerk/nuxt@8886

@clerk/react
npm i https://pkg.pr.new/@clerk/react@8886

@clerk/react-router
npm i https://pkg.pr.new/@clerk/react-router@8886

@clerk/shared
npm i https://pkg.pr.new/@clerk/shared@8886

@clerk/tanstack-react-start
npm i https://pkg.pr.new/@clerk/tanstack-react-start@8886

@clerk/testing
npm i https://pkg.pr.new/@clerk/testing@8886

@clerk/ui
npm i https://pkg.pr.new/@clerk/ui@8886

@clerk/upgrade
npm i https://pkg.pr.new/@clerk/upgrade@8886

@clerk/vue
npm i https://pkg.pr.new/@clerk/vue@8886

commit: 0d36a73
@kylemac
kylemac
merged commit 3b146a1
into
mainJun 17, 2026

49 checks passed

@kylemac
kylemac
deleted the

kylemac/swingset-agents-md

branch
June 17, 2026 01:15
@coderabbitaicoderabbitaiBot
mentioned this pull request
Jun 17, 2026
 Merged

9 tasks
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@alexcarpenteralexcarpenteralexcarpenter approved these changes

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

2 participants

@kylemac@alexcarpenter

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
docs(swingset): add Mosaic component documentation guidance - #8886
Merged
kylemac merged 1 commit into
mainfrom 
kylemac/swingset-agents-md
Jun 17, 2026
Merged
docs(swingset): add Mosaic component documentation guidance#8886
kylemac merged 1 commit into
mainfrom 
kylemac/swingset-agents-md
Conversation
@kylemac
@kylemackylemac
commented
Jun 17, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
TLDR
  • adds a bit more guidance around how we should document the various mosaic layers in swingset
  • cleans up a few instances where we ran afoul
  • adds a "default" column to our props table so its easier to see what the defaults are for each prop
Description
Adds a house style to packages/swingset/CLAUDE.md for documenting Mosaic components consistently: the six layers, three doc archetypes (simple vs. compound styled components, headless primitives, and composed layers), meta/story conventions, and a default-value convention. Brings the existing components into line with it — the auto-generated <PropTable> now renders a dedicated Default column (instead of inlining the default into the type), Composition.tsx gains the missing Panels layer in its ordering, and the OrganizationProfile and Destructive pages get their missing composition lists. Documentation/tooling only for the private, unpublished @clerk/swingset package, so an empty changeset is included. To test: run pnpm run dev:swingset and confirm component pages render with a clean type column plus a separate Default column, and that composed pages show their composition footers.
Checklist
  • pnpm test runs as expected.
  • pnpm build runs as expected.
  •  (If applicable) JSDoc comments have been added or updated for any package exports
  •  (If applicable) Documentation has been updated
Type of change
  •  🐛 Bug fix
  •  🌟 New feature
  •  🔨 Breaking change
  •  📖 Refactoring / dependency upgrade / documentation
  •  other:
Summary by CodeRabbit
  • New Features
    • Added a Default column to the property table for clearer visibility of component default values.
  • Documentation
    • Updated development documentation with comprehensive component documentation guidelines, including conventions for layers, metadata, and MDX section ordering.
    • Refreshed dev command guidance.
  • Chores
    • Reorganized component layer ordering and updated story compositions.
@kylemac
docs(swingset): add Mosaic component documentation guidance
0d36a73
Document the house style for component docs in CLAUDE.md: the six layers,
three archetypes (simple/compound styled components, headless primitives,
composed layers), meta conventions, and a default-value convention. Add a
Default column to the auto-generated PropTable and backfill missing
composition lists so existing components follow the guidance.
@changeset-bot
changeset-botBot
commented
Jun 17, 2026

Copy link


Copy Markdown

🦋 Changeset detected
Latest commit: 0d36a73
The changes in this PR will be included in the next version bump.
This PR includes changesets to release 0 packages
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
Not sure what this means? Click here to learn what changesets are.
Click here if you're a maintainer who wants to add another changeset to this PR
@vercel
vercelBot
commented
Jun 17, 2026•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJun 17, 2026 1:07am
swingsetReadyReadyPreview, CommentJun 17, 2026 1:07am
Request Review
@coderabbitai
coderabbitaiBot
commented
Jun 17, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Review Change Stack
📝 Walkthrough
Walkthrough
Adds a dedicated Default column to PropTable (splitting it from the Value column), inserts a Panels entry into Composition's LAYER_ORDER, populates composition props in the destructive and organization-profile MDX stories, and substantially expands CLAUDE.md with Mosaic component documentation archetypes and a pre-submission checklist.
Changes
Swingset UI and documentation improvements
Layer / File(s)Summary
PropTable: separate Default and Value columns
packages/swingset/src/components/PropTable.tsx		Adds a Default column header; Default cell renders row.default in <code> or an em dash; Value cell now only renders a KnobControl or em dash, no longer falls back to row.default.
Composition: insert Panels into LAYER_ORDER
packages/swingset/src/components/Composition.tsx		LAYER_ORDER gains a Panels entry between AIO and Sections, updating layerRank() results and CompositionPanel group sort order.
MDX stories: add composition props
packages/swingset/src/stories/destructive.mdx, packages/swingset/src/stories/organization-profile.mdx		destructive.mdx Default story gains a composition array for Button, Input, and Dialog; organization-profile.mdx replaces its prior single-view setup with OrganizationProfileGeneral + Tabs and updates description text.
CLAUDE.md: Mosaic documentation conventions and changeset
packages/swingset/CLAUDE.md, .changeset/swingset-docs-guidance.md		Fixes dev command typo; adds house-style section defining layer groups, meta fields, Archetype A/B/C MDX section orders, and a before-you-finish checklist. Changeset entry tracks the update.
Estimated code review effort
🎯 2 (Simple) | ⏱️ ~10 minutes
Possibly related PRs
  • clerk/javascript#8805: Both PRs modify packages/swingset/CLAUDE.md — the earlier PR initially establishes swingset agent guidance and this PR extends it with Mosaic component documentation archetypes.
  • clerk/javascript#8822: Both PRs modify packages/swingset/src/components/PropTable.tsx within the same component, with the earlier PR styling prop names using a Badge and this PR splitting Default from Value columns.
Suggested reviewers
  • alexcarpenter
🐇 A new column for defaults, hooray!

The Panels layer found its place today.

Stories now name each composed part,

And CLAUDE.md holds the doc-writing art.

Hop hop, the swingset swings just right! 🌟
🚥 Pre-merge checks | ✅ 4 | ❌ 1
❌ Failed checks (1 warning)
Check nameStatusExplanationResolution
Docstring Coverage⚠️ WarningDocstring 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 nameStatusExplanation
Title check✅ PassedThe pull request title accurately summarizes the main change: adding Mosaic component documentation guidance to swingset, which is the primary objective and most substantial change in CLAUDE.md.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
✏️ Tip: You can configure your own custom pre-merge checks in the settings.
✨ Finishing Touches
📝 Generate docstrings
  •  Create stacked PR
  •  Commit on current branch
Comment @coderabbitai help to get the list of available commands and usage tips.
@pkg-pr-new
pkg-pr-newBot
commented
Jun 17, 2026

Copy link


Copy Markdown

Open in StackBlitz
@clerk/astro
npm i https://pkg.pr.new/@clerk/astro@8886

@clerk/backend
npm i https://pkg.pr.new/@clerk/backend@8886

@clerk/chrome-extension
npm i https://pkg.pr.new/@clerk/chrome-extension@8886

@clerk/clerk-js
npm i https://pkg.pr.new/@clerk/clerk-js@8886

@clerk/expo
npm i https://pkg.pr.new/@clerk/expo@8886

@clerk/expo-passkeys
npm i https://pkg.pr.new/@clerk/expo-passkeys@8886

@clerk/express
npm i https://pkg.pr.new/@clerk/express@8886

@clerk/fastify
npm i https://pkg.pr.new/@clerk/fastify@8886

@clerk/hono
npm i https://pkg.pr.new/@clerk/hono@8886

@clerk/localizations
npm i https://pkg.pr.new/@clerk/localizations@8886

@clerk/nextjs
npm i https://pkg.pr.new/@clerk/nextjs@8886

@clerk/nuxt
npm i https://pkg.pr.new/@clerk/nuxt@8886

@clerk/react
npm i https://pkg.pr.new/@clerk/react@8886

@clerk/react-router
npm i https://pkg.pr.new/@clerk/react-router@8886

@clerk/shared
npm i https://pkg.pr.new/@clerk/shared@8886

@clerk/tanstack-react-start
npm i https://pkg.pr.new/@clerk/tanstack-react-start@8886

@clerk/testing
npm i https://pkg.pr.new/@clerk/testing@8886

@clerk/ui
npm i https://pkg.pr.new/@clerk/ui@8886

@clerk/upgrade
npm i https://pkg.pr.new/@clerk/upgrade@8886

@clerk/vue
npm i https://pkg.pr.new/@clerk/vue@8886

commit: 0d36a73
@kylemac
kylemac
merged commit 3b146a1
into
mainJun 17, 2026

49 checks passed

@kylemac
kylemac
deleted the

kylemac/swingset-agents-md

branch
June 17, 2026 01:15
@coderabbitaicoderabbitaiBot
mentioned this pull request
Jun 17, 2026
 Merged

9 tasks
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@alexcarpenteralexcarpenteralexcarpenter approved these changes

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

2 participants

@kylemac@alexcarpenter

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
docs(swingset): add Mosaic component documentation guidance - #8886
Merged
kylemac merged 1 commit into
mainfrom 
kylemac/swingset-agents-md
Jun 17, 2026
Merged
docs(swingset): add Mosaic component documentation guidance#8886
kylemac merged 1 commit into
mainfrom 
kylemac/swingset-agents-md
Conversation
@kylemac
@kylemackylemac
commented
Jun 17, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
TLDR
  • adds a bit more guidance around how we should document the various mosaic layers in swingset
  • cleans up a few instances where we ran afoul
  • adds a "default" column to our props table so its easier to see what the defaults are for each prop
Description
Adds a house style to packages/swingset/CLAUDE.md for documenting Mosaic components consistently: the six layers, three doc archetypes (simple vs. compound styled components, headless primitives, and composed layers), meta/story conventions, and a default-value convention. Brings the existing components into line with it — the auto-generated <PropTable> now renders a dedicated Default column (instead of inlining the default into the type), Composition.tsx gains the missing Panels layer in its ordering, and the OrganizationProfile and Destructive pages get their missing composition lists. Documentation/tooling only for the private, unpublished @clerk/swingset package, so an empty changeset is included. To test: run pnpm run dev:swingset and confirm component pages render with a clean type column plus a separate Default column, and that composed pages show their composition footers.
Checklist
  • pnpm test runs as expected.
  • pnpm build runs as expected.
  •  (If applicable) JSDoc comments have been added or updated for any package exports
  •  (If applicable) Documentation has been updated
Type of change
  •  🐛 Bug fix
  •  🌟 New feature
  •  🔨 Breaking change
  •  📖 Refactoring / dependency upgrade / documentation
  •  other:
Summary by CodeRabbit
  • New Features
    • Added a Default column to the property table for clearer visibility of component default values.
  • Documentation
    • Updated development documentation with comprehensive component documentation guidelines, including conventions for layers, metadata, and MDX section ordering.
    • Refreshed dev command guidance.
  • Chores
    • Reorganized component layer ordering and updated story compositions.
@kylemac
docs(swingset): add Mosaic component documentation guidance
0d36a73
Document the house style for component docs in CLAUDE.md: the six layers,
three archetypes (simple/compound styled components, headless primitives,
composed layers), meta conventions, and a default-value convention. Add a
Default column to the auto-generated PropTable and backfill missing
composition lists so existing components follow the guidance.
@changeset-bot
changeset-botBot
commented
Jun 17, 2026

Copy link


Copy Markdown

🦋 Changeset detected
Latest commit: 0d36a73
The changes in this PR will be included in the next version bump.
This PR includes changesets to release 0 packages
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
Not sure what this means? Click here to learn what changesets are.
Click here if you're a maintainer who wants to add another changeset to this PR
@vercel
vercelBot
commented
Jun 17, 2026•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJun 17, 2026 1:07am
swingsetReadyReadyPreview, CommentJun 17, 2026 1:07am
Request Review
@coderabbitai
coderabbitaiBot
commented
Jun 17, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Review Change Stack
📝 Walkthrough
Walkthrough
Adds a dedicated Default column to PropTable (splitting it from the Value column), inserts a Panels entry into Composition's LAYER_ORDER, populates composition props in the destructive and organization-profile MDX stories, and substantially expands CLAUDE.md with Mosaic component documentation archetypes and a pre-submission checklist.
Changes
Swingset UI and documentation improvements
Layer / File(s)Summary
PropTable: separate Default and Value columns
packages/swingset/src/components/PropTable.tsx		Adds a Default column header; Default cell renders row.default in <code> or an em dash; Value cell now only renders a KnobControl or em dash, no longer falls back to row.default.
Composition: insert Panels into LAYER_ORDER
packages/swingset/src/components/Composition.tsx		LAYER_ORDER gains a Panels entry between AIO and Sections, updating layerRank() results and CompositionPanel group sort order.
MDX stories: add composition props
packages/swingset/src/stories/destructive.mdx, packages/swingset/src/stories/organization-profile.mdx		destructive.mdx Default story gains a composition array for Button, Input, and Dialog; organization-profile.mdx replaces its prior single-view setup with OrganizationProfileGeneral + Tabs and updates description text.
CLAUDE.md: Mosaic documentation conventions and changeset
packages/swingset/CLAUDE.md, .changeset/swingset-docs-guidance.md		Fixes dev command typo; adds house-style section defining layer groups, meta fields, Archetype A/B/C MDX section orders, and a before-you-finish checklist. Changeset entry tracks the update.
Estimated code review effort
🎯 2 (Simple) | ⏱️ ~10 minutes
Possibly related PRs
  • clerk/javascript#8805: Both PRs modify packages/swingset/CLAUDE.md — the earlier PR initially establishes swingset agent guidance and this PR extends it with Mosaic component documentation archetypes.
  • clerk/javascript#8822: Both PRs modify packages/swingset/src/components/PropTable.tsx within the same component, with the earlier PR styling prop names using a Badge and this PR splitting Default from Value columns.
Suggested reviewers
  • alexcarpenter
🐇 A new column for defaults, hooray!

The Panels layer found its place today.

Stories now name each composed part,

And CLAUDE.md holds the doc-writing art.

Hop hop, the swingset swings just right! 🌟
🚥 Pre-merge checks | ✅ 4 | ❌ 1
❌ Failed checks (1 warning)
Check nameStatusExplanationResolution
Docstring Coverage⚠️ WarningDocstring 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 nameStatusExplanation
Title check✅ PassedThe pull request title accurately summarizes the main change: adding Mosaic component documentation guidance to swingset, which is the primary objective and most substantial change in CLAUDE.md.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
✏️ Tip: You can configure your own custom pre-merge checks in the settings.
✨ Finishing Touches
📝 Generate docstrings
  •  Create stacked PR
  •  Commit on current branch
Comment @coderabbitai help to get the list of available commands and usage tips.
@pkg-pr-new
pkg-pr-newBot
commented
Jun 17, 2026

Copy link


Copy Markdown

Open in StackBlitz
@clerk/astro
npm i https://pkg.pr.new/@clerk/astro@8886

@clerk/backend
npm i https://pkg.pr.new/@clerk/backend@8886

@clerk/chrome-extension
npm i https://pkg.pr.new/@clerk/chrome-extension@8886

@clerk/clerk-js
npm i https://pkg.pr.new/@clerk/clerk-js@8886

@clerk/expo
npm i https://pkg.pr.new/@clerk/expo@8886

@clerk/expo-passkeys
npm i https://pkg.pr.new/@clerk/expo-passkeys@8886

@clerk/express
npm i https://pkg.pr.new/@clerk/express@8886

@clerk/fastify
npm i https://pkg.pr.new/@clerk/fastify@8886

@clerk/hono
npm i https://pkg.pr.new/@clerk/hono@8886

@clerk/localizations
npm i https://pkg.pr.new/@clerk/localizations@8886

@clerk/nextjs
npm i https://pkg.pr.new/@clerk/nextjs@8886

@clerk/nuxt
npm i https://pkg.pr.new/@clerk/nuxt@8886

@clerk/react
npm i https://pkg.pr.new/@clerk/react@8886

@clerk/react-router
npm i https://pkg.pr.new/@clerk/react-router@8886

@clerk/shared
npm i https://pkg.pr.new/@clerk/shared@8886

@clerk/tanstack-react-start
npm i https://pkg.pr.new/@clerk/tanstack-react-start@8886

@clerk/testing
npm i https://pkg.pr.new/@clerk/testing@8886

@clerk/ui
npm i https://pkg.pr.new/@clerk/ui@8886

@clerk/upgrade
npm i https://pkg.pr.new/@clerk/upgrade@8886

@clerk/vue
npm i https://pkg.pr.new/@clerk/vue@8886

commit: 0d36a73
@kylemac
kylemac
merged commit 3b146a1
into
mainJun 17, 2026

49 checks passed

@kylemac
kylemac
deleted the

kylemac/swingset-agents-md

branch
June 17, 2026 01:15
@coderabbitaicoderabbitaiBot
mentioned this pull request
Jun 17, 2026
 Merged

9 tasks
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@alexcarpenteralexcarpenteralexcarpenter approved these changes

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

2 participants

@kylemac@alexcarpenter

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
docs(swingset): add Mosaic component documentation guidance - #8886
Merged
kylemac merged 1 commit into
mainfrom 
kylemac/swingset-agents-md
Jun 17, 2026
Merged
docs(swingset): add Mosaic component documentation guidance#8886
kylemac merged 1 commit into
mainfrom 
kylemac/swingset-agents-md
Conversation
@kylemac
@kylemackylemac
commented
Jun 17, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
TLDR
  • adds a bit more guidance around how we should document the various mosaic layers in swingset
  • cleans up a few instances where we ran afoul
  • adds a "default" column to our props table so its easier to see what the defaults are for each prop
Description
Adds a house style to packages/swingset/CLAUDE.md for documenting Mosaic components consistently: the six layers, three doc archetypes (simple vs. compound styled components, headless primitives, and composed layers), meta/story conventions, and a default-value convention. Brings the existing components into line with it — the auto-generated <PropTable> now renders a dedicated Default column (instead of inlining the default into the type), Composition.tsx gains the missing Panels layer in its ordering, and the OrganizationProfile and Destructive pages get their missing composition lists. Documentation/tooling only for the private, unpublished @clerk/swingset package, so an empty changeset is included. To test: run pnpm run dev:swingset and confirm component pages render with a clean type column plus a separate Default column, and that composed pages show their composition footers.
Checklist
  • pnpm test runs as expected.
  • pnpm build runs as expected.
  •  (If applicable) JSDoc comments have been added or updated for any package exports
  •  (If applicable) Documentation has been updated
Type of change
  •  🐛 Bug fix
  •  🌟 New feature
  •  🔨 Breaking change
  •  📖 Refactoring / dependency upgrade / documentation
  •  other:
Summary by CodeRabbit
  • New Features
    • Added a Default column to the property table for clearer visibility of component default values.
  • Documentation
    • Updated development documentation with comprehensive component documentation guidelines, including conventions for layers, metadata, and MDX section ordering.
    • Refreshed dev command guidance.
  • Chores
    • Reorganized component layer ordering and updated story compositions.
@kylemac
docs(swingset): add Mosaic component documentation guidance
0d36a73
Document the house style for component docs in CLAUDE.md: the six layers,
three archetypes (simple/compound styled components, headless primitives,
composed layers), meta conventions, and a default-value convention. Add a
Default column to the auto-generated PropTable and backfill missing
composition lists so existing components follow the guidance.
@changeset-bot
changeset-botBot
commented
Jun 17, 2026

Copy link


Copy Markdown

🦋 Changeset detected
Latest commit: 0d36a73
The changes in this PR will be included in the next version bump.
This PR includes changesets to release 0 packages
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
Not sure what this means? Click here to learn what changesets are.
Click here if you're a maintainer who wants to add another changeset to this PR
@vercel
vercelBot
commented
Jun 17, 2026•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJun 17, 2026 1:07am
swingsetReadyReadyPreview, CommentJun 17, 2026 1:07am
Request Review
@coderabbitai
coderabbitaiBot
commented
Jun 17, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Review Change Stack
📝 Walkthrough
Walkthrough
Adds a dedicated Default column to PropTable (splitting it from the Value column), inserts a Panels entry into Composition's LAYER_ORDER, populates composition props in the destructive and organization-profile MDX stories, and substantially expands CLAUDE.md with Mosaic component documentation archetypes and a pre-submission checklist.
Changes
Swingset UI and documentation improvements
Layer / File(s)Summary
PropTable: separate Default and Value columns
packages/swingset/src/components/PropTable.tsx		Adds a Default column header; Default cell renders row.default in <code> or an em dash; Value cell now only renders a KnobControl or em dash, no longer falls back to row.default.
Composition: insert Panels into LAYER_ORDER
packages/swingset/src/components/Composition.tsx		LAYER_ORDER gains a Panels entry between AIO and Sections, updating layerRank() results and CompositionPanel group sort order.
MDX stories: add composition props
packages/swingset/src/stories/destructive.mdx, packages/swingset/src/stories/organization-profile.mdx		destructive.mdx Default story gains a composition array for Button, Input, and Dialog; organization-profile.mdx replaces its prior single-view setup with OrganizationProfileGeneral + Tabs and updates description text.
CLAUDE.md: Mosaic documentation conventions and changeset
packages/swingset/CLAUDE.md, .changeset/swingset-docs-guidance.md		Fixes dev command typo; adds house-style section defining layer groups, meta fields, Archetype A/B/C MDX section orders, and a before-you-finish checklist. Changeset entry tracks the update.
Estimated code review effort
🎯 2 (Simple) | ⏱️ ~10 minutes
Possibly related PRs
  • clerk/javascript#8805: Both PRs modify packages/swingset/CLAUDE.md — the earlier PR initially establishes swingset agent guidance and this PR extends it with Mosaic component documentation archetypes.
  • clerk/javascript#8822: Both PRs modify packages/swingset/src/components/PropTable.tsx within the same component, with the earlier PR styling prop names using a Badge and this PR splitting Default from Value columns.
Suggested reviewers
  • alexcarpenter
🐇 A new column for defaults, hooray!

The Panels layer found its place today.

Stories now name each composed part,

And CLAUDE.md holds the doc-writing art.

Hop hop, the swingset swings just right! 🌟
🚥 Pre-merge checks | ✅ 4 | ❌ 1
❌ Failed checks (1 warning)
Check nameStatusExplanationResolution
Docstring Coverage⚠️ WarningDocstring 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 nameStatusExplanation
Title check✅ PassedThe pull request title accurately summarizes the main change: adding Mosaic component documentation guidance to swingset, which is the primary objective and most substantial change in CLAUDE.md.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
✏️ Tip: You can configure your own custom pre-merge checks in the settings.
✨ Finishing Touches
📝 Generate docstrings
  •  Create stacked PR
  •  Commit on current branch
Comment @coderabbitai help to get the list of available commands and usage tips.
@pkg-pr-new
pkg-pr-newBot
commented
Jun 17, 2026

Copy link


Copy Markdown

Open in StackBlitz
@clerk/astro
npm i https://pkg.pr.new/@clerk/astro@8886

@clerk/backend
npm i https://pkg.pr.new/@clerk/backend@8886

@clerk/chrome-extension
npm i https://pkg.pr.new/@clerk/chrome-extension@8886

@clerk/clerk-js
npm i https://pkg.pr.new/@clerk/clerk-js@8886

@clerk/expo
npm i https://pkg.pr.new/@clerk/expo@8886

@clerk/expo-passkeys
npm i https://pkg.pr.new/@clerk/expo-passkeys@8886

@clerk/express
npm i https://pkg.pr.new/@clerk/express@8886

@clerk/fastify
npm i https://pkg.pr.new/@clerk/fastify@8886

@clerk/hono
npm i https://pkg.pr.new/@clerk/hono@8886

@clerk/localizations
npm i https://pkg.pr.new/@clerk/localizations@8886

@clerk/nextjs
npm i https://pkg.pr.new/@clerk/nextjs@8886

@clerk/nuxt
npm i https://pkg.pr.new/@clerk/nuxt@8886

@clerk/react
npm i https://pkg.pr.new/@clerk/react@8886

@clerk/react-router
npm i https://pkg.pr.new/@clerk/react-router@8886

@clerk/shared
npm i https://pkg.pr.new/@clerk/shared@8886

@clerk/tanstack-react-start
npm i https://pkg.pr.new/@clerk/tanstack-react-start@8886

@clerk/testing
npm i https://pkg.pr.new/@clerk/testing@8886

@clerk/ui
npm i https://pkg.pr.new/@clerk/ui@8886

@clerk/upgrade
npm i https://pkg.pr.new/@clerk/upgrade@8886

@clerk/vue
npm i https://pkg.pr.new/@clerk/vue@8886

commit: 0d36a73
@kylemac
kylemac
merged commit 3b146a1
into
mainJun 17, 2026

49 checks passed

@kylemac
kylemac
deleted the

kylemac/swingset-agents-md

branch
June 17, 2026 01:15
@coderabbitaicoderabbitaiBot
mentioned this pull request
Jun 17, 2026
 Merged

9 tasks
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@alexcarpenteralexcarpenteralexcarpenter approved these changes

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

2 participants

@kylemac@alexcarpenter

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
docs(swingset): add Mosaic component documentation guidance - #8886
Merged
kylemac merged 1 commit into
mainfrom 
kylemac/swingset-agents-md
Jun 17, 2026
Merged
docs(swingset): add Mosaic component documentation guidance#8886
kylemac merged 1 commit into
mainfrom 
kylemac/swingset-agents-md
Conversation
@kylemac
@kylemackylemac
commented
Jun 17, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
TLDR
  • adds a bit more guidance around how we should document the various mosaic layers in swingset
  • cleans up a few instances where we ran afoul
  • adds a "default" column to our props table so its easier to see what the defaults are for each prop
Description
Adds a house style to packages/swingset/CLAUDE.md for documenting Mosaic components consistently: the six layers, three doc archetypes (simple vs. compound styled components, headless primitives, and composed layers), meta/story conventions, and a default-value convention. Brings the existing components into line with it — the auto-generated <PropTable> now renders a dedicated Default column (instead of inlining the default into the type), Composition.tsx gains the missing Panels layer in its ordering, and the OrganizationProfile and Destructive pages get their missing composition lists. Documentation/tooling only for the private, unpublished @clerk/swingset package, so an empty changeset is included. To test: run pnpm run dev:swingset and confirm component pages render with a clean type column plus a separate Default column, and that composed pages show their composition footers.
Checklist
  • pnpm test runs as expected.
  • pnpm build runs as expected.
  •  (If applicable) JSDoc comments have been added or updated for any package exports
  •  (If applicable) Documentation has been updated
Type of change
  •  🐛 Bug fix
  •  🌟 New feature
  •  🔨 Breaking change
  •  📖 Refactoring / dependency upgrade / documentation
  •  other:
Summary by CodeRabbit
  • New Features
    • Added a Default column to the property table for clearer visibility of component default values.
  • Documentation
    • Updated development documentation with comprehensive component documentation guidelines, including conventions for layers, metadata, and MDX section ordering.
    • Refreshed dev command guidance.
  • Chores
    • Reorganized component layer ordering and updated story compositions.
@kylemac
docs(swingset): add Mosaic component documentation guidance
0d36a73
Document the house style for component docs in CLAUDE.md: the six layers,
three archetypes (simple/compound styled components, headless primitives,
composed layers), meta conventions, and a default-value convention. Add a
Default column to the auto-generated PropTable and backfill missing
composition lists so existing components follow the guidance.
@changeset-bot
changeset-botBot
commented
Jun 17, 2026

Copy link


Copy Markdown

🦋 Changeset detected
Latest commit: 0d36a73
The changes in this PR will be included in the next version bump.
This PR includes changesets to release 0 packages
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
Not sure what this means? Click here to learn what changesets are.
Click here if you're a maintainer who wants to add another changeset to this PR
@vercel
vercelBot
commented
Jun 17, 2026•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJun 17, 2026 1:07am
swingsetReadyReadyPreview, CommentJun 17, 2026 1:07am
Request Review
@coderabbitai
coderabbitaiBot
commented
Jun 17, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Review Change Stack
📝 Walkthrough
Walkthrough
Adds a dedicated Default column to PropTable (splitting it from the Value column), inserts a Panels entry into Composition's LAYER_ORDER, populates composition props in the destructive and organization-profile MDX stories, and substantially expands CLAUDE.md with Mosaic component documentation archetypes and a pre-submission checklist.
Changes
Swingset UI and documentation improvements
Layer / File(s)Summary
PropTable: separate Default and Value columns
packages/swingset/src/components/PropTable.tsx		Adds a Default column header; Default cell renders row.default in <code> or an em dash; Value cell now only renders a KnobControl or em dash, no longer falls back to row.default.
Composition: insert Panels into LAYER_ORDER
packages/swingset/src/components/Composition.tsx		LAYER_ORDER gains a Panels entry between AIO and Sections, updating layerRank() results and CompositionPanel group sort order.
MDX stories: add composition props
packages/swingset/src/stories/destructive.mdx, packages/swingset/src/stories/organization-profile.mdx		destructive.mdx Default story gains a composition array for Button, Input, and Dialog; organization-profile.mdx replaces its prior single-view setup with OrganizationProfileGeneral + Tabs and updates description text.
CLAUDE.md: Mosaic documentation conventions and changeset
packages/swingset/CLAUDE.md, .changeset/swingset-docs-guidance.md		Fixes dev command typo; adds house-style section defining layer groups, meta fields, Archetype A/B/C MDX section orders, and a before-you-finish checklist. Changeset entry tracks the update.
Estimated code review effort
🎯 2 (Simple) | ⏱️ ~10 minutes
Possibly related PRs
  • clerk/javascript#8805: Both PRs modify packages/swingset/CLAUDE.md — the earlier PR initially establishes swingset agent guidance and this PR extends it with Mosaic component documentation archetypes.
  • clerk/javascript#8822: Both PRs modify packages/swingset/src/components/PropTable.tsx within the same component, with the earlier PR styling prop names using a Badge and this PR splitting Default from Value columns.
Suggested reviewers
  • alexcarpenter
🐇 A new column for defaults, hooray!

The Panels layer found its place today.

Stories now name each composed part,

And CLAUDE.md holds the doc-writing art.

Hop hop, the swingset swings just right! 🌟
🚥 Pre-merge checks | ✅ 4 | ❌ 1
❌ Failed checks (1 warning)
Check nameStatusExplanationResolution
Docstring Coverage⚠️ WarningDocstring 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 nameStatusExplanation
Title check✅ PassedThe pull request title accurately summarizes the main change: adding Mosaic component documentation guidance to swingset, which is the primary objective and most substantial change in CLAUDE.md.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
✏️ Tip: You can configure your own custom pre-merge checks in the settings.
✨ Finishing Touches
📝 Generate docstrings
  •  Create stacked PR
  •  Commit on current branch
Comment @coderabbitai help to get the list of available commands and usage tips.
@pkg-pr-new
pkg-pr-newBot
commented
Jun 17, 2026

Copy link


Copy Markdown

Open in StackBlitz
@clerk/astro
npm i https://pkg.pr.new/@clerk/astro@8886

@clerk/backend
npm i https://pkg.pr.new/@clerk/backend@8886

@clerk/chrome-extension
npm i https://pkg.pr.new/@clerk/chrome-extension@8886

@clerk/clerk-js
npm i https://pkg.pr.new/@clerk/clerk-js@8886

@clerk/expo
npm i https://pkg.pr.new/@clerk/expo@8886

@clerk/expo-passkeys
npm i https://pkg.pr.new/@clerk/expo-passkeys@8886

@clerk/express
npm i https://pkg.pr.new/@clerk/express@8886

@clerk/fastify
npm i https://pkg.pr.new/@clerk/fastify@8886

@clerk/hono
npm i https://pkg.pr.new/@clerk/hono@8886

@clerk/localizations
npm i https://pkg.pr.new/@clerk/localizations@8886

@clerk/nextjs
npm i https://pkg.pr.new/@clerk/nextjs@8886

@clerk/nuxt
npm i https://pkg.pr.new/@clerk/nuxt@8886

@clerk/react
npm i https://pkg.pr.new/@clerk/react@8886

@clerk/react-router
npm i https://pkg.pr.new/@clerk/react-router@8886

@clerk/shared
npm i https://pkg.pr.new/@clerk/shared@8886

@clerk/tanstack-react-start
npm i https://pkg.pr.new/@clerk/tanstack-react-start@8886

@clerk/testing
npm i https://pkg.pr.new/@clerk/testing@8886

@clerk/ui
npm i https://pkg.pr.new/@clerk/ui@8886

@clerk/upgrade
npm i https://pkg.pr.new/@clerk/upgrade@8886

@clerk/vue
npm i https://pkg.pr.new/@clerk/vue@8886

commit: 0d36a73
@kylemac
kylemac
merged commit 3b146a1
into
mainJun 17, 2026

49 checks passed

@kylemac
kylemac
deleted the

kylemac/swingset-agents-md

branch
June 17, 2026 01:15
@coderabbitaicoderabbitaiBot
mentioned this pull request
Jun 17, 2026
 Merged

9 tasks
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@alexcarpenteralexcarpenteralexcarpenter approved these changes

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

2 participants

@kylemac@alexcarpenter