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

docs: add short descriptions to some components #1966

Merged
merged 6 commits into from
Mar 21, 2022

Conversation

gui-santos
Copy link
Contributor

@gui-santos gui-santos commented Mar 21, 2022

Purpose of PR

This PR will add new descriptions created by @domarku to the following components:

  • Accordion
  • Asset
  • AssetCard
  • Autocomplete
  • Badge
  • Button
  • ButtonGroup
  • Card
  • Collapse
  • CopyButton
  • EntryCard
  • IconButton
  • ToggleButton

And it moves examples to TS files for the following components:

  • AssetCard
  • Collapse
  • EntryCard

PR Checklist

  • I have read the relevant readme.md file(s)
  • All commits follow our Git commit message convention
  • Tests are added/updated/not required
  • Tests are passing
  • Storybook stories are added/updated/not required
  • Usage notes are added/updated/not required
  • Has been tested based on Contentful's browser support
  • Doesn't contain any sensitive information

@changeset-bot
Copy link

changeset-bot bot commented Mar 21, 2022

⚠️ No Changeset found

Latest commit: f3b85e0

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

@vercel
Copy link

vercel bot commented Mar 21, 2022

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/contentful-apps/forma-36/3UpyZXFNjj9BGBnqvucMi6oPoCgY
✅ Preview: https://forma-36-git-feat-components-short-description-contentful-apps.vercel.app

@gui-santos gui-santos merged commit b460bce into main Mar 21, 2022
@gui-santos gui-santos deleted the feat/components-short-description branch March 21, 2022 16:42
denkristoffer pushed a commit that referenced this pull request Apr 4, 2022
* docs: add new descriptions to components

- Accordion
- Asset
- Autocomplete
- Badge
- Button
- ButtonGroup
- IconButton
- ToggleButton
- Card

* docs: add description and examples to AssetCard

* docs: add description and example to Collapse

* docs: adds description and examples to EntryCard

* docs: add description to CopyButton

* fix: lint error
denkristoffer pushed a commit to Wake1st/forma-36 that referenced this pull request Oct 5, 2022
* docs: add new descriptions to components

- Accordion
- Asset
- Autocomplete
- Badge
- Button
- ButtonGroup
- IconButton
- ToggleButton
- Card

* docs: add description and examples to AssetCard

* docs: add description and example to Collapse

* docs: adds description and examples to EntryCard

* docs: add description to CopyButton

* fix: lint error
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.

None yet

2 participants