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

fix(pie-docs): DSW-2222 add toast provider docs #2104

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

raoufswe
Copy link
Member

@raoufswe raoufswe commented Dec 2, 2024

Describe your changes (can list changeset entries if preferable)

  • Add the pie-toast-provider docs

Author Checklist (complete before requesting a review)

  • I have performed a self-review of my code
  • I have added thorough tests where applicable (unit / component / visual)
  • I have reviewed the Docs site preview
  • If there are visual test updates, I have reviewed them properly before approving

Reviewer checklists (complete before approving)

Reviewer 1 - @siggerzz

  • I have reviewed the Docs site preview
  • If new links have been added, I have tested them in the preview
  • If there are visual test updates, I have reviewed them

Reviewer 2

  • I have reviewed the Docs site preview
  • If new links have been added, I have tested them in the preview
  • If there are visual test updates, I have reviewed them

Copy link

changeset-bot bot commented Dec 2, 2024

⚠️ No Changeset found

Latest commit: 98ad3ba

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

@raoufswe raoufswe marked this pull request as ready for review December 2, 2024 14:30
@raoufswe raoufswe requested review from a team as code owners December 2, 2024 14:30
@pie-design-system-bot
Copy link
Contributor

pie-design-system-bot commented Dec 2, 2024




Fails
🚫 You have unchecked checklist items outside the "Not-applicable Checklist items" section.

Please ensure all unchecked checkboxes are moved to the appropriate section.

🚫 You have unchecked checklist items in Reviewer 1's section.

Please ensure all items are addressed before approval.

🚫 You have unchecked checklist items in Reviewer 2's section.

Please ensure all items are addressed before approval.

Generated by 🚫 dangerJS against 98ad3ba

Comment on lines +227 to +231
{% notification {
type: "information",
message: "The priority queue is managed by the [Toast Provider](/components/toast/toast-provider/code/) in engineering."
} %}

Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
{% notification {
type: "information",
message: "The priority queue is managed by the [Toast Provider](/components/toast/toast-provider/code/) in engineering."
} %}
{% notification {
type: "information",
message: "The priority queue is managed by the [Toast Provider](/components/toast/toast-provider/code/) component that's currently in development."
} %}

Just my POV, but I think this reads a bit nicer 👍🏼

{% notification {
type: "neutral",
iconName: "link",
message: "See [here](https://github.com/justeattakeaway/pie/blob/main/packages/components/pie-toast/CHANGELOG.md)."
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
message: "See [here](https://github.com/justeattakeaway/pie/blob/main/packages/components/pie-toast/CHANGELOG.md)."
message: "See [here](https://github.com/justeattakeaway/pie/blob/main/packages/components/pie-toast-provider/CHANGELOG.md)."

Note this this URL doesn't currently exist as the component hasn't been published to npm yet, but the changelog.md will get generated in this location once that's been done 👍🏼

Copy link
Contributor

@siggerzz siggerzz left a comment

Choose a reason for hiding this comment

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

Few minor comments

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants