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

Web Docs - Stepper Component #2727

Open
wants to merge 99 commits into
base: dchyun/stepper-component
Choose a base branch
from

Conversation

majedelass
Copy link
Contributor

@majedelass majedelass commented Feb 27, 2025

๐Ÿ“Œ Summary

If merged, this PR will add the Stepper component documentation to the website.

๐Ÿ› ๏ธ Detailed description

The Stepper documentation is getting slightly restructured, where the previous Stepper Indicator will now live under a Stepper category, along side Stepper Navigation and Stepper List.

๐Ÿ“ธ Screenshots

Before
Screenshot 2025-02-27 at 11 01 24โ€ฏAM

After
Screenshot 2025-03-03 at 12 03 04โ€ฏPM

๐Ÿ”— External links

Jira ticket: HDS-4405


๐Ÿ’ฌ Please consider using conventional comments when reviewing this PR.

@majedelass majedelass requested review from a team as code owners February 27, 2025 02:26
Copy link

vercel bot commented Feb 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 Mar 14, 2025 6:54pm
hds-website โœ… Ready (Inspect) Visit Preview Mar 14, 2025 6:54pm

@hashibot-hds hashibot-hds added the docs-website Content updates to the documentation website label Feb 27, 2025
@dchyun dchyun changed the base branch from main to dchyun/stepper-component February 27, 2025 13:12
@dchyun

This comment was marked as resolved.

@KristinLBradley
Copy link
Contributor

KristinLBradley commented Mar 13, 2025

Added a couple more minor suggestions.
"a" user vs. "the" user started to bother me but that's something we could maybe talk about/think about more so feel free to apply related suggestions or not as you think best. (I don't think we are consistent elsewhere.)
@dchyun @hashicorp/hds-engineering Since in the guidelines we say that the Stepper Nav should always be used together with navigation Buttons, I think it would be useful/helpful to include at least one example in the Code tab that includes Buttons for navigation. Would like to know what others think though.

@KristinLBradley I'd prefer to keep the existing code docs examples as limited as possible and just show the Hds::Stepper::Nav, but we could add a new section called "Composition with other components" and mirror what is talked about in the guidelines. Would that work?

@dchyun That's fair, thanks.

I think it could be helpful to add another section but I don't think it's a blocker.

Co-authored-by: Kristin Bradley <kristin.bradley@hashicorp.com>
Co-authored-by: Kristin Bradley <kristin.bradley@hashicorp.com>
Co-authored-by: Kristin Bradley <kristin.bradley@hashicorp.com>
Co-authored-by: Lee White <lee.white@hashicorp.com>
Copy link
Contributor

@shleewhite shleewhite 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, just seems like the branch needs to get back in sync with the component branch to clean up the git history/files changed.

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 packages/components showcase
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants