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.

Sign up for GitHub

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

Jump to bottom

Add/improve docs tests #340

Closed
6 of 24 tasks
shawnbot opened this issue Sep 11, 2017 · 2 comments
Closed
6 of 24 tasks

Add/improve docs tests #340

shawnbot opened this issue Sep 11, 2017 · 2 comments
Assignees
@jonrohan @shawnbot

Comments

@shawnbot
Copy link
Contributor

shawnbot commented Sep 11, 2017 •
edited
Loading

I noticed when going through each of the Primer CSS modules to update their test scripts in #334 that most are missing docs tests that ensure our documentation references all of the classes modified in the module's SCSS. Here's the list based on the presence of test-docs script in each module's package.json:

  • primer-alerts
  • primer-avatars
  • primer-base
  • primer-blankslate
  • primer-box
  • primer-breadcrumb
  • primer-buttons
  • primer-cards (soon to be deprecated)
  • primer-core (meta)
  • primer-css (meta)
  • primer-dropdown
  • primer-forms
  • primer-labels
  • primer-layout
  • primer-markdown
  • primer-marketing-support (support)
  • primer-marketing-type
  • primer-marketing-utilities
  • primer-marketing
  • primer-navigation
  • primer-page-headers
  • primer-page-sections
  • primer-product (meta)
  • primer-support (support)
  • primer-table-object
  • primer-tables
  • primer-tooltips
  • primer-truncate
  • primer-utilities
@shawnbot shawnbot added the docs label Sep 11, 2017
@shawnbot shawnbot mentioned this issue Sep 11, 2017
Merged
@shawnbot
Copy link
Contributor Author

@broccolini and I agreed that we should aim to add the docs test to all of the CSS modules and whitelist any classes that don't need to be explicitly documented.

@shawnbot
Copy link
Contributor Author

/cc @emplums for future docs stuff

@simurai simurai closed this as completed Dec 31, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jonrohan jonrohan

@shawnbot shawnbot

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@jonrohan @shawnbot @simurai