docs: tighten component description first paragraphs#712
Merged
pixelflips merged 23 commits intomainfrom Apr 17, 2026
Merged
Conversation
✅ Deploy Preview for pine-design-system ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
Code reviewFound 1 issue:
🤖 Generated with Claude Code - If this code review was useful, please react with 👍. Otherwise, react with 👎. |
QuintonJason
approved these changes
Apr 17, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Rewrites the first paragraph under the
# Headingof 21 component docs MDX files so that each lead sentence stands alone as a usable short description of the component. The pine-mcp server consumes the first paragraph of every component's docs MDX to populate thelist_pine_componentstool's Description column; the existing copy was mostly boilerplate ("The X component is used to…") or, in two cases, missing entirely.Rewrites are copy-only. No structural changes, no renames, no MDX-syntax changes — only the paragraph directly under the component's
# Headingis touched. All other sections (Guidelines, Properties, Accessibility, examples, etc.) are untouched.Related work on the consumer side: DSS-193.
What changed (21 files, 21 focused commits)
pds-alert,pds-avatar,pds-copytext,pds-icon,pds-loader,pds-multiselect,pds-progress,pds-property,pds-select,pds-tabs,pds-textpds-filters,pds-radio-group,pds-row,pds-table,pds-textpds-dropdown-menu,pds-modalpds-switch(previously described as "A styled checkbox component" — now accurately describes a switch as a form-associated toggle with a sliding thumb affordance)pds-input,pds-textarea,pds-toastStyle applied
Type of change
How Has This Been Tested?
Test Configuration:
docs/tighten-component-descriptionsbranch offmainVerification performed:
npm start) used to spot-check the rendered docs pages forpds-dropdown-menuandpds-modal(where a paragraph was added),pds-switch(meaning change),pds-rowandpds-filters(inline markdown removed).Checklist:
cc @Kajabi/dss-devs for Design System review.