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(TextInput): update documentation + stories #2590

Merged
merged 4 commits into from
Oct 20, 2023

Conversation

cf-remylenoir
Copy link
Collaborator

@cf-remylenoir cf-remylenoir commented Oct 13, 2023

Purpose of PR

This work takes care of updating our Documentation and Storybook based on the latest API changes.

Documentation

Storybook

  • Addition of the icon and group examples to the Overview

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 Oct 13, 2023

⚠️ No Changeset found

Latest commit: 8b32755

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

@cf-remylenoir cf-remylenoir self-assigned this Oct 13, 2023
@vercel
Copy link

vercel bot commented Oct 13, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
forma-36 ✅ Ready (Inspect) Visit Preview Oct 20, 2023 0:59am

@github-actions
Copy link

github-actions bot commented Oct 13, 2023

size-limit report 📦

Path Size Loading time (3g) Running time (snapdragon) Total time
CommonJS 129.58 KB (0%) 2.6 s (0%) 136 ms (+103% 🔺) 2.8 s
Module 126.04 KB (0%) 2.6 s (0%) 103 ms (+6.8% 🔺) 2.7 s

@cf-remylenoir cf-remylenoir marked this pull request as ready for review October 16, 2023 13:41
@cf-remylenoir cf-remylenoir requested review from Lelith, damann and a team as code owners October 16, 2023 13:42
Copy link

@damann damann left a comment

Choose a reason for hiding this comment

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

Sorry, this is really, really nit-picky. The punctuation with the comma seems a bit off. _"It is possible …, it will be rendered …" I want to make sure we

Can you please change it to something like:
It is possible to provide an icon to the TextInput, and it will be displayed on the left-hand side of the input. or
It is possible to provide an icon to the TextInput. It will be displayed on the left-hand side of the input.

I'm also not sure if we need the "Example of usage:" That should be obvious.

Other than that, it's all good. Thanks!

@cf-remylenoir cf-remylenoir merged commit b4dec6f into main Oct 20, 2023
12 checks passed
@cf-remylenoir cf-remylenoir deleted the F36-805-text-input-documentation branch October 20, 2023 14:22
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