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

[FX-5703] Remove storybook-readme #4426

Merged
merged 1 commit into from
Jul 29, 2024
Merged

Conversation

mkrl
Copy link
Contributor

@mkrl mkrl commented Jul 29, 2024

FX-5703

Description

Backports what { doc } from 'storybook-readme' used to do to our internal 'react-markdown' renderer.

Fixes https://github.com/toptal/picasso/security/dependabot/156

How to test

  • Temploy
  • Look at all the doc pages, they should be visually unchanged (with some exceptions)
  • Some of the elements actually look nicer now as previously some styles were applied twice

Screenshots

Before. After.
image image
image image

Development checks

All development checks should be done and set checked to pass the
GitHub Bot: TODOLess action

PR commands

List of available commands:

  • @toptal-bot run package:alpha-release - Release alpha version
  • @toptal-anvil ping reviewers - Ping FX team for review
PR Review Guidelines

When to approve? ✅

You are OK with merging this PR and

  1. You have no extra requests.
  2. You have optional requests.
    1. Add nit: to your comment. (ex. nit: I'd rename this variable from makeCircle to getCircle)

When to request changes? ❌

You are not OK with merging this PR because

  1. Something is broken after the changes.
  2. Acceptance criteria is not reached.
  3. Code is dirty.

When to comment (neither ✅ nor ❌)

You want your comments to be addressed before merging this PR in cases like:

  1. There are leftovers like unnecessary logs, comments, etc.
  2. You have an opinionated comment regarding the code that requires a discussion.
  3. You have questions.

How to handle the comments?

  1. An owner of a comment is the only one who can resolve it.
  2. An owner of a comment must resolve it when it's addressed.
  3. A PR owner must reply with ✅ when a comment is addressed.

@mkrl mkrl self-assigned this Jul 29, 2024
@mkrl mkrl requested a review from a team July 29, 2024 14:56
Copy link

changeset-bot bot commented Jul 29, 2024

⚠️ No Changeset found

Latest commit: b9efc1e

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

@mkrl
Copy link
Contributor Author

mkrl commented Jul 29, 2024

@toptal-anvil ping reviewers

Copy link
Contributor

@sashuk sashuk left a comment

Choose a reason for hiding this comment

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

Code looks good, the change actually fixed some of the problems

Before

Screenshot 2024-07-29 at 16 30 30

Now

Screenshot 2024-07-29 at 16 31 20

@sashuk sashuk requested a review from a team July 29, 2024 15:31
Copy link
Collaborator

@OleksandrNechai OleksandrNechai left a comment

Choose a reason for hiding this comment

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

The code looks 👍 Thanks!

@mkrl mkrl merged commit 054224a into master Jul 29, 2024
22 of 24 checks passed
@mkrl mkrl deleted the fx-5703-picasso-html-minifier branch July 29, 2024 17:25
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.

3 participants