Skip to content

Web docs Spacing docs migration #3013

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 12 commits into from
Jul 17, 2025
Merged

Web docs Spacing docs migration #3013

merged 12 commits into from
Jul 17, 2025

Conversation

majedelass
Copy link
Contributor

@majedelass majedelass commented Jul 15, 2025

📌 Summary

If merged, this PR will migrate all mentions of "Spacing" from the Guidelines tab to the Specifications tab.

Vercel deployment 👉 https://hds-website-git-spacing-docs-migration-hashicorp.vercel.app/components/

🛠️ Detailed description

The specific docs that this PR affects (each links to Vercel deploy):

🔗 External links

Jira ticket: HDS-4715


@majedelass majedelass requested review from a team as code owners July 15, 2025 12:37
Copy link

vercel bot commented Jul 15, 2025

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

Name Status Preview Updated (UTC)
hds-showcase ✅ Ready (Inspect) Visit Preview Jul 16, 2025 4:01pm
hds-website ✅ Ready (Inspect) Visit Preview Jul 16, 2025 4:01pm

@majedelass majedelass marked this pull request as draft July 15, 2025 12:37
@hashibot-hds hashibot-hds added the docs-website Content updates to the documentation website label Jul 15, 2025
jorytindall
jorytindall previously approved these changes Jul 15, 2025
Copy link
Contributor

@jorytindall jorytindall left a comment

Choose a reason for hiding this comment

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

I won't block on it (and I'm not sure I remember when this conversation was had), but I'm not sure I agree with all of these (I've called some of them out, but not all). There are spacing specifications that are not determined by consumers and are not the responsibility of them to implement; e.g., Breadcrumb, Tooltip/RichTooltip. But there are many of these where it is guidance because a consumer has to implement it and we use the language "we recommend". If we determine it's better to have all of the spacing-related content in the same tab, then that's fine, but I don't think the premise that this is purely informational is necessarily true in all cases.

@heatherlarsen
Copy link
Contributor

I agree with what @jorytindall noted above. The overall intention of this update is to move Spacing documentation where predefined spacing is present in the component, rather than when spacing is documented as a guideline that consumers need to implement themselves. There may be situations when both are needed, as well.

@majedelass
Copy link
Contributor Author

@heatherlarsen @jorytindall all fair. Originally I was thinking: should all spacing be moved so that a consumer knows that ALL spacing is in a specific space, regardless if it's a consumer implementation or not, but this makes sense.

The way I see it (in alignment with what folks are saying) is that it should follow how "States" is represented. It's not a consumer needed implementation, but they should be generally aware of this.

Thanks y'all ill update.

Copy link
Contributor

@jorytindall jorytindall left a comment

Choose a reason for hiding this comment

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

Thanks for rethinking all of this, looks good!

Copy link
Contributor

@didoo didoo left a comment

Choose a reason for hiding this comment

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

👍

@majedelass majedelass merged commit 9c2d241 into main Jul 17, 2025
11 checks passed
@majedelass majedelass deleted the spacing-docs-migration branch July 17, 2025 12:22
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.

5 participants