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

[WNMGDS-2160] Consolidate docs theme #2922

Conversation

zarahzachz
Copy link
Collaborator

@zarahzachz zarahzachz commented Feb 6, 2024

WNMGDS-2160

  • Docs site should only use core theme and no longer switch its appearance based on user theme selection
  • Accordions used in docs site should be styled as Healthcare's accordion style
  • Embedded examples should show selected theme
    • How do we reflect theming for our foundation documentation (e.g., body text)
    • Storybook embeds do reflect chosen theme

Demo url

I am seeing a bug with this demo link, but it's a bug that exists in PROD so it seems like it's out of scope for this PR (see video for bug)

Screen.Recording.2024-02-06.at.5.14.17.PM.mov

The best I can describe it, the site seems to "forget" its theme and defaults to Core until you navigate to other pages within the site.

@zarahzachz zarahzachz marked this pull request as draft February 6, 2024 18:53
@zarahzachz zarahzachz changed the base branch from main to feature/info-architecture-update February 6, 2024 18:53
@zarahzachz zarahzachz marked this pull request as ready for review February 6, 2024 22:41
@zarahzachz
Copy link
Collaborator Author

this branch has the latest of all UI updates in it:

  • includes updates from base feature/info-architecture-update branch
  • includes Accordion from hgov
  • removes ability for docs site to be themed, but keeps themed Storybook embeds

only reason I'm asking for a review in this branch instead of merging it into the info-architecture one is i'm not sure we want to keep the "persisting theme on docs site" work. open to discussing, but i personally found it hard to know what theme i was looking at when everything looked the same. it could be some sorta bias though since i've been working in this site for so long - i just don't think the core theme looks distinct enough from hgov to be our default docs look and it could confuse non-hgov users on our site

@zarahzachz zarahzachz changed the title [WIP] [WNMGDS-2160] Consolidate docs theme [WNMGDS-2160] Consolidate docs theme Feb 6, 2024
@pwolfert
Copy link
Collaborator

pwolfert commented Feb 7, 2024

One way that would provide a clue about what theme they're looking at that seems to be missing in this branch is the background color of the theme-switcher section changing to match the primary color for that theme

@zarahzachz
Copy link
Collaborator Author

One way that would provide a clue about what theme they're looking at that seems to be missing in this branch is the background color of the theme-switcher section changing to match the primary color for that theme

Or changing the title name in the header to reflect which theme was active like this:

image

or

Screenshot 2024-02-06 at 8 03 22 PM

Bonus points for having a stylized logo for each theme

@pwolfert
Copy link
Collaborator

pwolfert commented Feb 7, 2024

Well the color thing was in the original designs, or I would have pushed back on the idea. I think we at least need the brand color somewhere.

@hi-its-hailey
Copy link

Oh yeah, I vote for the brand color on the theme swither itself! The header switch would also be good, but I could see it being a more missable difference. Otherwise, looks good!

@zarahzachz zarahzachz merged commit dfa072c into feature/info-architecture-update Feb 7, 2024
1 check passed
@zarahzachz zarahzachz deleted the WNMGDS-2160/consolidate-docs-theme branch February 7, 2024 14:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants