18F / 18f.gsa.gov

The 18F website
https://18f.gsa.gov
Other
291 stars 311 forks source link

Investigate removing 18F style guide #3700

Closed geekygirlsarah closed 6 months ago

geekygirlsarah commented 1 year ago

Feature suggestion

The 18F Style Guide, located at https://18f.gsa.gov/styleguide/ , seems like an outdated and old relic from a time past. The layout doesn't work. My search across files can't find anywhere it's linked. I imagine anything useful is already in the UX guide or Brand guide. I think this could be removed (both the _styleguide directory as well as layout/styleguide.html).

User story

As a developer/user of this repo, I want to remove the old 18F Style Guide so I can have a simpler repo with less old material.

Other considerations and design implementation suggestions

alexbielen commented 1 year ago

Hey Sarah! This feels related to TLC Crew Initiative 2 (Improving the maintainability of 18F guides and methods) and I think it makes sense to pull it in when we start the consolidation in earnest. Moving to the Icebox for now though.

annepetersen commented 1 year ago

We do use this and it gets a decent amount of traffic; in 2022, in fact, more traffic than the Engineering Hiring Guide.

Tagging them in to make sure @igorkorenfeld, @cmajel and @quarterback are aware of this proposal to remove the Brand Guide.

alexbielen commented 1 year ago

@annepetersen are we talking about the same guide?

It looks like this is about https://18f.gsa.gov/styleguide/ and not https://brand.18f.gov/

cmajel commented 1 year ago

brand.18f.gov/ is well loved and used, so keep her! ❤️

https://18f.gsa.gov/styleguide/ is less so. Originally, it looked like this, and documented UI patterns and guidance for the 18F website.

My two cents are this isn't serving us in it's current form. But, having pattern guidance and consistency across 18F sites is useful for faster builds and brand experience.

geekygirlsarah commented 1 year ago

Yes, definitely referring to the broken style guide (the latter), not the brand guide (the former). (We're definitely integrating that into the replatforming project.)

If we (18F) feel like it needs to still exist in some form, then perhaps a ticket should be put on one of the guides to try to write up the latest patterns we use. But this should probably still get removed from here.

igorkorenfeld commented 1 year ago

I'm wondering if we might repurpose the "https://18f.gsa.gov/styleguide/" site for the re-platforming effort? Might that be a helpful visual guide? Realizing, of course, that keeping it would be another site to maintain.

juliaklindpaintner commented 6 months ago

This guide has been removed.