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

chore: v5 update Avatar docs #262

Merged
merged 2 commits into from
Dec 18, 2024
Merged

chore: v5 update Avatar docs #262

merged 2 commits into from
Dec 18, 2024

Conversation

nurm717123
Copy link
Contributor

@nurm717123 nurm717123 commented Dec 17, 2024

This pr is to update Avatar and AvatarRectangle docs to be more aligned with other existing docs.

Pull request checklist

  • rename stories from Size: Small to Avatar with small size .etc
  • standardize first section of mdx docs to display available props
  • remove StylesOnlyUsage and ReactUsage
  • use <Description /> from @storybook/blocks if necessary

updated docs:

2024-12-18.10-43-22.mov

@nurm717123 nurm717123 requested a review from ksolanki7 December 17, 2024 09:06
Copy link

codacy-production bot commented Dec 17, 2024

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
Report missing for 2660c861
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (2660c86) Report Missing Report Missing Report Missing
Head commit (438d800) 4512 4054 89.85%

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details
Coverable lines Covered lines Diff coverage
Pull request (#262) 0 0 ∅ (not applicable)

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

Codacy stopped sending the deprecated coverage status on June 5th, 2024. Learn more

Footnotes

  1. Codacy didn't receive coverage data for the commit, or there was an error processing the received data. Check your integration for errors and validate that your coverage setup is correct.

Copy link
Contributor

@ksolanki7 ksolanki7 left a comment

Choose a reason for hiding this comment

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

@nurm717123 praise: Thanks for actioning the nitpicks for the stories. Just some minor polish require.

src/components/avatar/avatar.stories.tsx Outdated Show resolved Hide resolved
src/components/avatar/avatar.stories.tsx Outdated Show resolved Hide resolved
src/components/avatar/avatar.stories.tsx Outdated Show resolved Hide resolved
@nurm717123 nurm717123 requested a review from ksolanki7 December 18, 2024 03:43
Copy link
Contributor

@ksolanki7 ksolanki7 left a comment

Choose a reason for hiding this comment

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

praise: Looks good now.

@nurm717123 nurm717123 merged commit 34b4daf into main Dec 18, 2024
6 checks passed
@nurm717123 nurm717123 deleted the 137-fix-avatar-docs branch December 18, 2024 06:33
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