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

Updates to Documentation #103

Merged
merged 2 commits into from
Sep 16, 2022
Merged

Updates to Documentation #103

merged 2 commits into from
Sep 16, 2022

Conversation

hnprashanth
Copy link
Member

@hnprashanth hnprashanth commented Sep 14, 2022 •
edited by pruthvi2103
Loading

Description

  • List - Added a hyperlink to all available emoji codes for reference
  • Badge - "Badge with position", "Badge with a child" - Documentation uses button variant "dark" which is not available in the library, switching to "default".
  • Card - Imports "Card" from library but uses "CardComponent" throughout the examples. When people use this it will error out. In the code "CardComponent" is defined as
    export const CardComponent = ({ variant, children }) => (<Card variant={variant}>{children}</Card>); which is an abstraction of Card component. So removed this and replaced it everywhere with just "Card"
  • Native Select - "NativeSelect Rounded" remove error prop to match the expected outcome shown in the docs (i.e, normal rounded Native Select without any errors)
  • TextArea - fixedSize prop should be boolean, not string

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.

@netlify
Copy link

netlify bot commented Sep 14, 2022 •
edited
Loading

✅ Deploy Preview for hover-design ready!

Name Link
🔨 Latest commit 68c93ab
🔍 Latest deploy log https://app.netlify.com/sites/hover-design/deploys/6323e7682f51d400097ec72a
😎 Deploy Preview https://deploy-preview-103--hover-design.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@hnprashanth hnprashanth marked this pull request as draft September 14, 2022 13:51
@hnprashanth hnprashanth marked this pull request as ready for review September 16, 2022 03:05
@hnprashanth hnprashanth changed the title Draft: Updates to Documentation Updates to Documentation Sep 16, 2022
pruthvi2103
pruthvi2103 approved these changes Sep 16, 2022
View reviewed changes
Copy link
Contributor

@pruthvi2103 pruthvi2103 left a comment

Choose a reason for hiding this comment

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

LGTM, Thanks!!

@pruthvi2103 pruthvi2103 merged commit e4db658 into antstackio:main Sep 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pruthvi2103 pruthvi2103 pruthvi2103 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@hnprashanth @pruthvi2103