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.

Sign up for GitHub

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

Jump to bottom

Avatar: update minor documentation #1771

Merged
merged 13 commits into from
Aug 8, 2023
Merged

Avatar: update minor documentation #1771

merged 13 commits into from
Aug 8, 2023

Conversation

monicawheeler
Copy link
Collaborator

@monicawheeler monicawheeler commented Jul 31, 2023 •
edited
Loading

Description

Update minor aspects of documentation related to Avatar.

  • Removed outdated images
  • Updated Avatar example for react stories

Testing in sage-lib

View React documentation to ensure Avatar is working as expected
http://localhost:4100/?path=/docs/sage-avatar--default

Testing in kajabi-products

  1. (LOW) No testing needed, documentation updates only
    2

@monicawheeler monicawheeler self-assigned this Jul 31, 2023
@monicawheeler monicawheeler changed the title Avatar/missing initials react Avatar: missing initials in react Jul 31, 2023
@monicawheeler monicawheeler marked this pull request as ready for review July 31, 2023 19:43
@monicawheeler monicawheeler requested a review from a team July 31, 2023 19:43
@monicawheeler monicawheeler marked this pull request as draft July 31, 2023 19:49
@monicawheeler
Copy link
Collaborator Author

monicawheeler commented Jul 31, 2023 •
edited by jira bot
Loading

Moved into Draft to investigate if this is necessary due to SAGE-427

@monicawheeler monicawheeler marked this pull request as ready for review August 2, 2023 19:55
@monicawheeler monicawheeler requested review from ju-Skinner and a team and removed request for ju-Skinner August 2, 2023 19:55
@pixelflips pixelflips requested a review from a team August 2, 2023 20:29
Monica Wheeler and others added 11 commits August 7, 2023 10:34
@monicawheeler
docs(avatar): update Ruby Avatar component documentation
75f34f6
@monicawheeler
docs(avatar): update documentation for Avatar component
6700afb
@monicawheeler
feat(avatar): add initials and lazy load support to avatar component
7ea2d8f 
- Add support for initials to be displayed when image source is not available
- Implement lazy loading of initials in the avatar component as a helper
@monicawheeler
docs(avatar): update wording on Avatar description
bf1ce54 
- Updated Rails
- Updated React
@monicawheeler
feat: add two new examples to React Storybook
808183b 
- Add an example showcasing the usage of the 'initial' feature in the Avatar component
@monicawheeler
docs: update Avatar documentation on Ruby doc site
08f59d5 
- Elaborate on the usage of initials and lazy loading for Avatar
- Clarify that the initials option can be used independently
- Explain how to disable lazy loading by setting `lazy_load_initials` to false
@monicawheeler
feat(avatar): remove obsolete images for avatar
0c63e08
@monicawheeler
feat(avatar): update naming in files to generic folks
66061d5
@monicawheeler
fix(avatar): remove previous updates
983fdf9
@monicawheeler
fix(avatar): remove initial story
6bec95a
@monicawheeler
fix(avatar): update example for WithImage
34c9174
@monicawheeler monicawheeler requested review from pixelflips and removed request for ju-Skinner and a team August 7, 2023 15:45
@monicawheeler monicawheeler requested review from a team and ju-Skinner August 7, 2023 15:46
pixelflips
pixelflips approved these changes Aug 7, 2023
View reviewed changes
Copy link
Member

@pixelflips pixelflips left a comment

Choose a reason for hiding this comment

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

LGTM! Nice update! 👍🏼

@pixelflips pixelflips requested a review from a team August 7, 2023 15:47
@monicawheeler monicawheeler changed the title Avatar: missing initials in react Avatar: update minor documentation Aug 7, 2023
ju-Skinner
ju-Skinner requested changes Aug 7, 2023
View reviewed changes
Copy link
Collaborator

@ju-Skinner ju-Skinner left a comment

Choose a reason for hiding this comment

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

See comment under Button.story.jsx

packages/sage-react/lib/Button/Button.story.jsx Outdated Show resolved Hide resolved
QuintonJason
QuintonJason approved these changes Aug 7, 2023
View reviewed changes
Copy link
Contributor

@QuintonJason QuintonJason left a comment

Choose a reason for hiding this comment

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

Approved, pending @ju-Skinner 's comment

ju-Skinner
ju-Skinner requested changes Aug 7, 2023
View reviewed changes
Copy link
Collaborator

@ju-Skinner ju-Skinner left a comment

Choose a reason for hiding this comment

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

LIne 4, Button.story.jsx can be removed since it is no longer being used. This will also address the Linting error.

import { Avatar } from '../Avatar';

ju-Skinner
ju-Skinner approved these changes Aug 8, 2023
View reviewed changes
Copy link
Collaborator

@ju-Skinner ju-Skinner left a comment

Choose a reason for hiding this comment

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

Great job. Thanks for being patient with me and my feedback.

@monicawheeler monicawheeler merged commit 5ecdc35 into develop Aug 8, 2023
4 checks passed
@monicawheeler monicawheeler deleted the avatar/missing-initials-react branch August 8, 2023 15:45
@monicawheeler monicawheeler mentioned this pull request Aug 8, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pixelflips pixelflips pixelflips approved these changes

@QuintonJason QuintonJason QuintonJason approved these changes

@ju-Skinner ju-Skinner ju-Skinner approved these changes

Assignees

@monicawheeler monicawheeler

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@monicawheeler @pixelflips @QuintonJason @ju-Skinner