search

ni / nimble

The NI Nimble Design System
https://nimble.ni.dev
MIT License
29 stars 9 forks source link

Improve API docs for buttons and improve overall doc consistency #2117

Closed jattasNI closed 1 month ago

jattasNI commented 1 month ago

Pull Request

🤨 Rationale

As part of #824 we want to improve the accuracy and comprehensiveness of our storybook API documentation.

👩‍💻 Implementation

  1. Update button, toggle-button, and card-button to follow new API doc pattern. (I'll do anchor-button along with other anchors).
  2. Add and tweak wording on shared documentation strings and utilities
  3. Tweak organization of MDX headings in all stories to put Appearance and Sizing under Styling
  4. Add CONTRIBUTING guidance about referring to sections within docs (in previous PRs we gave up on trying to link to sections and started using bolded text instead).

🧪 Testing

Local storybook exploration

✅ Checklist