Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve API documentation of table components #2140

Merged
merged 69 commits into from
May 30, 2024
Merged

Improve API documentation of table components #2140

merged 69 commits into from
May 30, 2024

Conversation

jattasNI
Copy link
Contributor

@jattasNI jattasNI commented May 29, 2024

Pull Request

🀨 Rationale

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

πŸ‘©β€πŸ’» Implementation

Mostly following established patterns. Some interesting notes:

  1. 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!
  2. The above resulted in a renamed story which appears as a Chromatic diff.

πŸ§ͺ Testing

Interacting with the built Storybook.

βœ… Checklist

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

@jattasNI jattasNI marked this pull request as ready for review May 29, 2024 14:38
@jattasNI jattasNI requested a review from rajsite as a code owner May 29, 2024 14:38
@jattasNI jattasNI requested a review from m-akinc May 29, 2024 14:38
@jattasNI
Copy link
Contributor Author

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

@jattasNI jattasNI requested a review from fredvisser as a code owner May 30, 2024 13:34
@jattasNI
Copy link
Contributor Author

Bypassing reviewer policy due to OOO.

@jattasNI jattasNI merged commit aca764d into main May 30, 2024
13 checks passed
@jattasNI jattasNI deleted the api-docs-table branch May 30, 2024 13:51
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