Skip to content

docs: tighten component description first paragraphs#712

Merged
pixelflips merged 23 commits intomainfrom
docs/tighten-component-descriptions
Apr 17, 2026
Merged

docs: tighten component description first paragraphs#712
pixelflips merged 23 commits intomainfrom
docs/tighten-component-descriptions

Conversation

@pixelflips
Copy link
Copy Markdown
Member

Description

Rewrites the first paragraph under the # Heading of 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 the list_pine_components tool'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 # Heading is 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)

  • Boilerplate-lead replacements (subject-led rewrites): pds-alert, pds-avatar, pds-copytext, pds-icon, pds-loader, pds-multiselect, pds-progress, pds-property, pds-select, pds-tabs, pds-text
  • Inline code / markdown residue removed: pds-filters, pds-radio-group, pds-row, pds-table, pds-text
  • Added first paragraph where none existed: pds-dropdown-menu, pds-modal
  • Accuracy fix: pds-switch (previously described as "A styled checkbox component" — now accurately describes a switch as a form-associated toggle with a sliding thumb affordance)
  • Completed noun-phrase to full-sentence: pds-input, pds-textarea, pds-toast

Style applied

  • First sentence ≤160 char target, ≤200 hard cap (soft cap used by the downstream extractor).
  • Subject-led prose ("Buttons trigger actions…"), avoiding "The X component…" openings.
  • No inline markdown, code spans, or React/MDX components in the first paragraph.
  • Subsequent sentences in the same paragraph may add nuance — only the lead is typically surfaced to MCP consumers.

Type of change

  • This change requires a documentation update (docs-only copy update)

How Has This Been Tested?

  • tested manually

Test Configuration:

  • Pine versions: current docs/tighten-component-descriptions branch off main
  • OS: macOS (Darwin 25.4.0)
  • Browsers: verified in local Storybook dev server
  • Screen readers: N/A (copy-only change; no semantic/interaction changes)

Verification performed:

  1. Node-based auditor script run before and after edits to confirm every first paragraph now has a clean, subject-led lead sentence within the character targets.
  2. Local Storybook (npm start) used to spot-check the rendered docs pages for pds-dropdown-menu and pds-modal (where a paragraph was added), pds-switch (meaning change), pds-row and pds-filters (inline markdown removed).
  3. No visual regression elsewhere on any checked page; no browser console errors.

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing tests pass locally with my changes
  • Design has QA'ed and approved this PR

cc @Kajabi/dss-devs for Design System review.

@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 17, 2026

Deploy Preview for pine-design-system ready!

Name Link
🔨 Latest commit 76348c0
🔍 Latest deploy log https://app.netlify.com/projects/pine-design-system/deploys/69e2b066c0f9cc0008762f69
😎 Deploy Preview https://deploy-preview-712--pine-design-system.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions github-actions Bot added documentation Improvements or additions to documentation package: core Changes have been made to the Core package labels Apr 17, 2026
@pixelflips pixelflips self-assigned this Apr 17, 2026
@pixelflips pixelflips requested a review from QuintonJason April 17, 2026 21:56
@QuintonJason
Copy link
Copy Markdown
Contributor

Code review

Found 1 issue:

  1. pds-table description omits pds-table-head-cell subcomponent — the new opening paragraph lists pds-table-head, pds-table-body, pds-table-row, and pds-table-cell, but leaves out pds-table-head-cell, which is a distinct subcomponent with its own component directory, stories, and tests.

Tables display tabular data using semantic subcomponents for head, body, rows, and cells. Use pds-table-head, pds-table-body, pds-table-row, and pds-table-cell to compose rows and columns accessibly.

🤖 Generated with Claude Code

- If this code review was useful, please react with 👍. Otherwise, react with 👎.

@pixelflips pixelflips merged commit bdcb91e into main Apr 17, 2026
16 checks passed
@pixelflips pixelflips deleted the docs/tighten-component-descriptions branch April 17, 2026 22:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation package: core Changes have been made to the Core package

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants