Skip to content

Group 4: Banner and Image audit on the website #2907

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

Merged
merged 4 commits into from
Jun 4, 2025

Conversation

andgen404
Copy link
Contributor

@andgen404 andgen404 commented May 27, 2025

Group 3: @majedelass and @KristinLBradley

What:
You’ll review and approve PRs that update banner and image placement across our documentation pages. Each PR will follow these standards:

  • Banners should appear below the page heading or directly above the related content.
  • Images should appear below the content they reference.
    Each PR will include context and a summary of changes.

You’ll review alongside a design partner, ensuring both design and engineering teams are involved in each update.

📌 Summary

If merged, this PR will complete updates for the following component pages as part of the audit:

  • Button
  • Code-editor
  • Flyout
  • Form / File-input
  • Form / Masked-input
  • Modal
  • Page-header
  • Flex
  • Grid

All other pages (7) total are okay with no changes needed.

  • Badge Count
  • Breadcrumb
  • Form / Checkbox
  • Form / Radio
  • Form / Radio Card
  • Link / Standalone Link
  • Popover Primitive

🔗 External links

Jira ticket: HDS-4425
Google Sheet file: Here


👀 Component checklist

💬 Please consider using conventional comments when reviewing this PR.

In this audit I fixed the following component pages:
- Button
- Code-editor
- Flyout
- Form / File-input
- Form / Masked-input
- Modal
- Page-header
- Flex
- Grid
---
All other pages (x) total are okay with no changes needed
Copy link

vercel bot commented May 27, 2025

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

Name Status Preview Updated (UTC)
hds-showcase ✅ Ready (Inspect) Visit Preview May 30, 2025 6:18am
hds-website ✅ Ready (Inspect) Visit Preview May 30, 2025 6:18am

@hashibot-hds hashibot-hds added the docs-website Content updates to the documentation website label May 27, 2025
@andgen404 andgen404 marked this pull request as ready for review May 27, 2025 18:44
@andgen404 andgen404 requested review from a team as code owners May 27, 2025 18:44
Copy link
Contributor

@majedelass majedelass left a comment

Choose a reason for hiding this comment

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

Left some feedback.

I noticed some banners not being directly under the heading but from a content perspective it made sense to me.

@KristinLBradley
Copy link
Contributor

@andgen404 Should I be checking banner placement on the "Code" tab as well as the "Guidelines" tab?

For example, this one from the MaskedInput Code tab:
image

@andgen404
Copy link
Contributor Author

@andgen404 Should I be checking banner placement on the "Code" tab as well as the "Guidelines" tab?

For example, this one from the MaskedInput Code tab: image

Yes, both tabs. If a banner placement feels out of place, please note it. Thank you!

Copy link
Contributor

@majedelass majedelass left a comment

Choose a reason for hiding this comment

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

This looks good to me now 👍

Copy link
Contributor

@KristinLBradley KristinLBradley left a comment

Choose a reason for hiding this comment

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

Looks good

@andgen404 andgen404 merged commit dfb9a34 into main Jun 4, 2025
10 checks passed
@andgen404 andgen404 deleted the website-banner-image-audit-group--4 branch June 4, 2025 16:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs-website Content updates to the documentation website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants