Skip to content

Regenerate checkout docs with sentence-case fixes#4049

Open
jhoffmcd wants to merge 1 commit into2026-01from
jhoffmcd-03-06-regenerate-checkout-docs-with-sentence-case-fixes
Open

Regenerate checkout docs with sentence-case fixes#4049
jhoffmcd wants to merge 1 commit into2026-01from
jhoffmcd-03-06-regenerate-checkout-docs-with-sentence-case-fixes

Conversation

@jhoffmcd
Copy link

@jhoffmcd jhoffmcd commented Mar 6, 2026

Background

This pull request updates component documentation in the UI extensions checkout surface to improve clarity and consistency across component descriptions.

Solution

Updated component documentation with more detailed and consistent descriptions:

  • Button component: Changed "Use button" to "Use buttons" for better grammar
  • DropZone component: Renamed to "Drop zone" and expanded description to include drag-and-drop functionality, file type validation, and error handling details
  • Modal component: Enhanced description to explain the commandFor attribute trigger mechanism and scrolling behavior
  • Popover component: Completely rewrote description to explain the commandFor attribute, provide clearer usage guidance, and include a reference to the modal component for comparison
  • Typography components: Updated subcategory from "Titles and text" to "Typography and content" for abbreviation and time components

These changes provide developers with clearer guidance on when and how to use each component, including technical implementation details and cross-references to related components.

🎩

  • Enhanced component descriptions with technical implementation details
  • Improved grammar and consistency across component documentation
  • Added cross-references between related components (popover/modal)
  • Updated component categorization for better organization

Checklist

  • I have 🎩'd these changes
  • I have updated relevant documentation

Copy link
Author

jhoffmcd commented Mar 6, 2026

@jhoffmcd jhoffmcd marked this pull request as ready for review March 6, 2026 18:29
@jhoffmcd jhoffmcd requested a review from avocadomayo March 6, 2026 18:30
@jhoffmcd jhoffmcd self-assigned this Mar 6, 2026
@jhoffmcd jhoffmcd force-pushed the jhoffmcd-03-06-regenerate-checkout-docs-with-sentence-case-fixes branch from 69a996a to 4509bd7 Compare March 6, 2026 23:53
@graphite-app graphite-app bot changed the base branch from jhoffmcd-03-06-fix-doc-generation-for-sentence-case-component-names to 2026-01 March 6, 2026 23:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants