njostonehouse/valence-ui-docs

Documentation for the Valence UI components.

Welcome to Valence UI Docs

##Purpose This repo contains the source files for generating the documentation set for the Valence UI components.

• Written in reStructuredText
• Tested by rendering in Sphinx on Travis CI

##Documentation for VUI You can find the completed documentation for Valence UI at ui.valence.d2l.com

##Process for updating docs For any docs updates, please perform the following:

1. Fork this repository
2. Check out a branch to make your changes on.
3. Make your changes.
4. Commit with a descriptive message, and submit a pull request from your branch to master.
5. Verify that your pull request successfully built the docs on Travis CI. Your commit will contain a message that has a URL of where you can review the rendered docs.

• One of the editors will review the change, and either merge your changes in or provide feedback.