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.

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

feat(pie-docs): DSW-000 centralise more information link for code pages #2207

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

feat(pie-docs): DSW-000 centralise more information link for code pages #2207

wants to merge 2 commits into from

Conversation

jamieomaguire
Copy link
Contributor

@jamieomaguire jamieomaguire commented Feb 12, 2025 •
edited by raoufswe
Loading

Describe your changes (can list changeset entries if preferable)

  • Centralises the more information notification used across all component code pages so we can update the messaging in a single place
  • Extends the message to include a link to the integration guides (based on user feedback)
  • Uses an information variant of the notification to be more noticeable
Screenshot 2025-02-12 at 12 18 47

Author Checklist (complete before requesting a review, do not delete any)

  • I have performed a self-review of my code.
  • I have reviewed the PIE Storybook/PIE Docs PR preview.
  • I have reviewed visual test updates properly before approving.

Not-applicable Checklist items

Please move any Author checklist items that do not apply to this pull request here.

  • I have added thorough tests where applicable (unit / component / visual).
  • If changes will affect consumers of the package, I have created a changeset entry.
  • If a changeset file has been created, I have tested these changes in PIE Aperture using the /test-aperture command.

Testing

How do I test my changes?

Task Link
Aperture PR N/A
NextJS 14 deployment N/A
Nuxt 3 deployment N/A
Vanilla deployment N/A

Reviewer checklists (complete before approving)

Mark items as [-] N/A if not applicable.

Reviewer 1

  • I have reviewed the PIE Docs PR preview.
  • [-] N/A I have verified that all acceptance criteria for this ticket have been completed.
  • [-] N/A I have reviewed the Aperture changes (if added)
  • If there are visual test updates, I have reviewed them.

Reviewer 2

  • I have reviewed the PIE Docs PR preview.
  • [-] N/A I have verified that all acceptance criteria for this ticket have been completed.
  • [-] N/A I have reviewed the Aperture changes (if added)
  • If there are visual test updates, I have reviewed them.

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Feb 12, 2025 •
edited
Loading

🦋 Changeset detected

Latest commit: 2fdd666

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
pie-docs Patch

Not sure what this means? Click here to learn what changesets are.

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

@jamieomaguire jamieomaguire marked this pull request as ready for review February 12, 2025 12:26
@jamieomaguire jamieomaguire requested review from a team as code owners February 12, 2025 12:26
@pie-design-system-bot
Copy link
Contributor

pie-design-system-bot commented Feb 12, 2025 •
edited
Loading



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 2's section.

Please ensure all items are addressed before approval.

Generated by 🚫 dangerJS against 2fdd666

xander-marjoram
xander-marjoram reviewed Feb 12, 2025
View reviewed changes
apps/pie-docs/src/_11ty/shortcodes/index.js
@@ -38,6 +39,7 @@ const addAllShortCodes = (eleventyConfig) => {
eleventyConfig.addShortcode('list', (shortcodeArgs) => deindentHTML(list(shortcodeArgs)));
eleventyConfig.addShortcode('mediaElementList', (shortcodeArgs) => deindentHTML(mediaElement(shortcodeArgs)));
eleventyConfig.addShortcode('notification', (shortcodeArgs) => deindentHTML(notification(shortcodeArgs)));
eleventyConfig.addShortcode('componentCodeMoreInformationNotification', () => deindentHTML(componentCodeMoreInformationNotification));
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit: Insert alphabetically pls

Copy link
Contributor

Choose a reason for hiding this comment

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

And the import above while you're at it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@xander-marjoram xander-marjoram xander-marjoram approved these changes

@raoufswe raoufswe raoufswe approved these changes

Assignees
No one assigned
Labels
apps pie-docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@jamieomaguire @pie-design-system-bot @xander-marjoram @raoufswe