README.md

PGM XML Documentation

Website source for docs.oc.tc. Uses the ruby staticmatic gem to build a static documentation website.

Editing

1. Markdown should be used for content and haml for layout and data. ¹
2. Care should be taken when removing trailing whitespace since markdown uses two spaces to create a newline.

Pull Requests

Pull requests should have the following things:

1. The commits should have a descriptive message and which is not in the past tense.

   For example:
   Describe the XYZ module with more detail. or Add detailed description for XYZ. is good, but: Added XYZ. isn't.

2. Content should be grammatically correct and the spelling should be US English, e.g. Color not Colour.

Previewing your changes

1. Install ruby (Mac, Windows, Ubuntu) (we don't need rails, so just install ruby)
2. Install the bundler gem.
3. Run bundle install from the source root.
4. Run staticmatic preview or bundle exec staticmatic preview
5. Load localhost:4000 in your browser.