-
Notifications
You must be signed in to change notification settings - Fork 16
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
Reset and document Prose component styles #390
Conversation
dd6d5b8
to
18a9405
Compare
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.
The Prose styling looks good to me - Nothing that appears outstanding to flag.
Thinking about the next steps
- Create a "Prose" typography section in LGDS Figma
- Brief guidance for "Prose" vs. default, i.e., Prose for static sites
- When this PR is approved, announce that Prose is available, and used for static sites
Anything in addition?
I recall we'd implemented custom styles for the brochure site since we wanted specific text styling that wasn't reflected by Prose at the time. Do we think we'd need a review step to reconcile potential changes if we were to introduce the prose style reset to the brochure site, or should we just assume that Prose is correct as-is, even if it results in some spacing deviations from the current brochure site? As far as specifics of rolling this out, this might be one we'd consider to be a "Breaking Change" which doesn't mean whole lot in terms of potential impact, but it could be wise for us (me) to ship the current unreleased changes in a minor release, so we could offer an incremental upgrade path for downstream projects. There's at least one other breaking change I have planned (dropping support for IE11), so it could be good timing to pair with that. |
It'd be good to have a review step for pages with running text, like Help Center articles. Other brochure site pages can be a lightweight visual check. For Developers and Partners, do we want to notify Team Ursula (?) that Prose is available if they want to implement it, if not already?
This sounds like a good pairing. |
Ok, what I might do is this:
I think a review process using beta releases like described in the list above would make sense for the developer site, sure 👍 I might take that on myself to initiate and coordinate review with the partnerships teams. |
Smells like a plan! 👃🏼 |
18a9405
to
e2226a2
Compare
e2226a2
to
a2570c6
Compare
Visual regression failures are expected since (1) there's a new sidebar navigation link for Prose documentation and (2) the internal documentation site itself uses Prose, which would be affected by these styling changes. |
All steps up to this are complete, and the preview pull request is at GSA-TTS/identity-site#1207 |
🛠 Summary of changes
Removes override styles for the Prose component and adds a preview page to the internal documentation.
Related Slack discussion: https://gsa-tts.slack.com/archives/C01JVKYE4KD/p1702914619083849
Related LGDS Office Hours discussion notes: https://docs.google.com/document/d/10b7Gis_VxYT3roR01MX4hwPa6-Tq29YBaLPIB3vWnUw/edit#bookmark=id.w558e3npl6ym
Live preview URL: https://federalist-340d8801-aa16-4df5-ad22-b1e3e731098e.sites.pages.cloud.gov/preview/18f/identity-design-system/aduth-typography-prose/prose/
(Draft pending audit of effect of removing overrides)
👀 Screenshots