Skip to content

Update component docs (CircleBadge, Flash) #1717

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
Merged
merged 5 commits into from
Dec 17, 2021
Merged

Update component docs (CircleBadge, Flash) #1717

merged 5 commits into from
Dec 17, 2021

Conversation

@colebemis
Copy link
Contributor

@colebemis colebemis commented Dec 11, 2021 •
edited
Loading

Part of #1701

  • CircleBadge
  • Flash

@changeset-bot
Copy link

changeset-bot bot commented Dec 11, 2021 •
edited
Loading

⚠️ No Changeset found

Latest commit: 8e120a4

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions
Copy link
Contributor

github-actions bot commented Dec 11, 2021 •
edited
Loading

size-limit report 📦

Path Size
dist/browser.esm.js 56.33 KB (0%)
dist/browser.umd.js 56.68 KB (0%)

@colebemis colebemis changed the title Update component docs (CircleBadge, FilteredSearch, FilterSearch, FilterList, Flash) Update component docs (CircleBadge, FilteredSearch, FilterList, Flash) Dec 11, 2021
@colebemis colebemis changed the title Update component docs (CircleBadge, FilteredSearch, FilterList, Flash) Update component docs (CircleBadge, FilteredSearch, FilterList, Flash, FormGroup)) Dec 11, 2021
@colebemis colebemis changed the title Update component docs (CircleBadge, FilteredSearch, FilterList, Flash, FormGroup)) Update component docs (CircleBadge, FilteredSearch, FilterList, Flash, FormGroup) Dec 13, 2021
@colebemis colebemis added the skip changeset This change does not need a changelog label Dec 13, 2021
@colebemis colebemis changed the title Update component docs (CircleBadge, FilteredSearch, FilterList, Flash, FormGroup) Update component docs (CircleBadge, Flash) Dec 17, 2021
colebemis
colebemis commented Dec 17, 2021
View reviewed changes
docs/src/props-table.js
<Row
name="as"
defaultValue={`"${defaultElementType}"`}
defaultValue={isComponent ? defaultElementType : `"${defaultElementType}"`}
Copy link
Contributor Author

@colebemis colebemis Dec 17, 2021

Choose a reason for hiding this comment

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

This prevents component names from being displayed as strings ("Overlay" vs Overlay)

@colebemis colebemis marked this pull request as ready for review December 17, 2021 18:00
@colebemis colebemis requested review from a team and siddharthkp December 17, 2021 18:00
rezrah
rezrah reviewed Dec 17, 2021
View reviewed changes
docs/content/CircleBadge.mdx
@@ -0,0 +1,93 @@
---
componentId: circle_badge
Copy link
Contributor

@rezrah rezrah Dec 17, 2021

Choose a reason for hiding this comment

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

Total nitpick, but why do we put componentId at the top? I feel like title should always go first and componentId at the bottom as it's the least useful for those scanning this file.

Copy link
Contributor Author

@colebemis colebemis Dec 17, 2021

Choose a reason for hiding this comment

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

I'm fine with either :) The only reason I put it on the top was to try to avoid merge conflicts with other PRs 😅

@colebemis colebemis merged commit 44fb2a3 into main Dec 17, 2021
@colebemis colebemis deleted the component-docs-2 branch December 17, 2021 19:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@rezrah rezrah rezrah approved these changes

@siddharthkp siddharthkp Awaiting requested review from siddharthkp

Assignees

No one assigned

Labels

skip changeset This change does not need a changelog

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@colebemis @rezrah