-
Notifications
You must be signed in to change notification settings - Fork 51
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
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
There was a problem hiding this 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.
website/docs/components/copy/button/partials/specifications/spacing.md
Outdated
Show resolved
Hide resolved
website/docs/components/link/standalone/partials/specifications/spacing.md
Outdated
Show resolved
Hide resolved
website/docs/components/reveal/partials/specifications/spacing.md
Outdated
Show resolved
Hide resolved
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. |
@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. |
There was a problem hiding this 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!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
📌 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