ni / nimble

The NI Nimble Design System

https://nimble.ni.dev

MIT License

29 stars 9 forks source link

Improve API documentation of table components #2140

Closed jattasNI closed 1 month ago

jattasNI commented 1 month ago

Pull Request

🤨 Rationale

Ongoing efforts towards #824. This PR covers the table and its columns.

👩‍💻 Implementation

Mostly following established patterns. Some interesting notes:

For the Table Column Configuration doc, we had divided the documentation into separate targeted stories. I decided these were useful but we also should have a single table describing the whole API of a column. I created the latter under the API section and moved the targeted stories to an Examples section. Let me know if it feels right!
The above resulted in a renamed story which appears as a Chromatic diff.

🧪 Testing

Interacting with the built Storybook.

✅ Checklist

[x] I have updated the project documentation to reflect my changes or determined no changes are needed.

jattasNI commented 1 month ago

@m-akinc Here's another round of API docs for you to buddy. Thanks!

jattasNI commented 1 month ago

Bypassing reviewer policy due to OOO.