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 banner, incubating, and spright components #2141

Merged
merged 12 commits into from
May 31, 2024

Conversation

jattasNI
Copy link
Contributor

@jattasNI jattasNI commented May 30, 2024

Pull Request

🤨 Rationale

Ongoing efforts towards #824. This PR covers the remaining components: banner, incubating components, and spright components.

After this completes all the components are done but there are still some cross-component consistency improvements described in a checklist on #824.

👩‍💻 Implementation

Following standard patterns from previous PRs: reorganizing MDX headings, adding categories to each parameter in the args table, and making language and naming more consistent.

For the rich text components I also migrated some content around to better fit our standard document structure.

🧪 Testing

Inspected 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 30, 2024 18:55
@jattasNI jattasNI requested a review from rajsite as a code owner May 30, 2024 18:55
@jattasNI jattasNI enabled auto-merge (squash) May 31, 2024 16:38
@jattasNI jattasNI merged commit 2cb8968 into main May 31, 2024
11 checks passed
@jattasNI jattasNI deleted the api-docs-banner-etc branch May 31, 2024 16:52
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