Skip to content
Haplo Documentation
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
root
script
snippets/platform
web
.gitignore
COPYRIGHT
LICENSE
README.md

README.md

Haplo Documentation

Documentation for the Haplo Platform

Editing the documentation

To set up:

  • install jruby, make sure it's in your PATH
  • run jgem install RedCloth -v 4.2.9
  • check out the main Haplo repository at the same level as this repository

To preview your changes:

  • run script/doc-tool
  • visit localhost:8899 in your browser.

Adding new files requires a restart, but otherwise click refresh to view your changes.

Before committing your changes, check all the files with:

script/doc-tool check

This ensures that all the documentation can be generated, in particular, that all the links point to a valid destination.

License

Haplo Documentation is licensed under the Mozilla Public License Version 2.0. See the LICENSE file for full details.

Copyright

Haplo Documentation is copyright Haplo Services Ltd. See the COPYRIGHT file for full details.

You can’t perform that action at this time.