Skip to content

Conversation

@pixelflips
Copy link
Member

@pixelflips pixelflips commented Nov 20, 2025

Description

Standardized Pine component documentation structure to improve developer experience and consistency across all components.

This PR implements a unified documentation structure with consistent section ordering, adds missing content sections, and ensures all technical details are properly documented.

Key changes:

  • Enforced consistent section ordering: Guidelines → Usage Notes → Properties → Examples → Events → Form Integration → Technical Notes → Additional Resources
  • Added Form Integration sections to all form-associated components explaining name/value submission, FormData behavior, and validation patterns
  • Added Technical Notes sections documenting accessibility implementation details, programmatic APIs, and component behavior
  • Added missing Examples headings to group usage demonstrations consistently
  • Enhanced forms and events guides with additional patterns and examples

Fixes DSS-15

Type of change

  • This change requires a documentation update

How Has This Been Tested?

  • tested manually

Test Configuration:

  • Verified all MDX files render correctly in Storybook
  • Confirmed section ordering adheres to approved structure across all components
  • Validated form integration documentation against component source code
  • Reviewed technical notes for accuracy

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings

@pixelflips pixelflips self-assigned this Nov 20, 2025
@netlify
Copy link

netlify bot commented Nov 20, 2025

Deploy Preview for pine-design-system ready!

Name Link
🔨 Latest commit e51668b
🔍 Latest deploy log https://app.netlify.com/projects/pine-design-system/deploys/691fa1d4761aa50008f52bed
😎 Deploy Preview https://deploy-preview-594--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 Nov 20, 2025
@pixelflips pixelflips marked this pull request as ready for review November 20, 2025 23:26
@pixelflips
Copy link
Member Author

@QuintonJason this one looks large but it's mostly clean up and reorg to standardize the component docs. Let me know if you have any questions when reviewing.

Copy link
Contributor

@QuintonJason QuintonJason left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good to go

@pixelflips pixelflips merged commit 37991c2 into main Nov 21, 2025
17 checks passed
@pixelflips pixelflips deleted the docs/standardize-docs-sections branch November 21, 2025 19:10
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.

3 participants