search

uswds / uswds

The U.S. Web Design System helps the federal government build fast, accessible, mobile-friendly websites.
https://designsystem.digital.gov
Other
6.82k stars 933 forks source link

Add KSS Documentation #1494

Closed RobLoach closed 6 years ago

RobLoach commented 8 years ago

KSS provides a way to add CSS documentation, allowing you to expose the components directly in a styleguide, automagically.

Description

I'd like to add KSS documentation to all the components in the USWDS.

Steps to reproduce the issue

  1. Install a KSS client (like kss-node)
  2. Run KSS on the USWDS source
  3. See that the USWDS components are not part of the styleguide

    Additional information

To add KSS documentation directly to the source, we would pretty much write CSS docs for each available component, copying them from the official styleguide, directly inline with the SCSS itself. Then, you could expose each component in a KSS styleguide.

maya commented 8 years ago

Hi @RobLoach, thanks for reaching out about the KSS documentation on the Standards.

We don't have plans to implement KSS documentation at this point in time, however feel free to follow along our roadmap https://standards.usa.gov/about-our-work/product-roadmap/ and project wiki to stay up to date on what we're working on next: https://github.com/18F/web-design-standards/wiki

If you'd like to provide some context around your use case, that will help the team get a better idea of your needs.

RobLoach commented 6 years ago

For those following along, this became kss-uswds. You can see the built styleguide over at: https://kalamuna.github.io/kss-uswds/section-uswds.html