Updating the Style Guide

  • page
updating-style-guide  

Documentation Rules

CSS documentation should be placed as close to the code as possible. Follow these rules to determine where the documentation should live:

  • If documenting styles from a component, place documentation in the .less file for that component.
  • If documenting custom styles that overwrite bootstrap, place documentation on the corresponding files under the bootstrap-custom directory
  • Else, place documentation on the corresponding files under the variables directory.

Documentation System

As new code is written or refactored, is important to keep the documention updated. This documentation uses DocumentCSS in conjuction with DocumentJS. Refer to the following links to learn how to: