Skip to content

Latest commit

 

History

History
31 lines (19 loc) · 1.07 KB

README.md

File metadata and controls

31 lines (19 loc) · 1.07 KB

ORR Documentation source

The master branch of this repository contains the source of the ORR documentation.

The documentation source is written in plain text files using Markdown syntax.

We use MkDocs tool for the site generation.

NOTE: We are migrating contents from the original site as well as doing reviewing and updates per recent developments in new version ORR v3.

Your help improving this documentation is welcome!

Generation

The documentation, which is reflected at https://mmisw.org/orrdoc/, is automatically generated upon changes pushed to this repo.

In particular, the API documentation at https://mmisw.org/orrdoc/api/ is currently generated as explained here.

Local testing

Please see the MkDocs documentation if you are testing things under your local clone.