Skip to content

Latest commit

 

History

History
19 lines (13 loc) · 813 Bytes

README.md

File metadata and controls

19 lines (13 loc) · 813 Bytes

omi-doc

Raw documentation repository for several content available in OMI github repos

The documentation uses mkdocs as a Content Management System (CMS) to publish the content. This repository barely stores the raw or source content of the OMI documentation.

To update the published doc, the raw content is required to be transformed in publishable data. Once transformed, mkdocs gh-deploy operation will automatically update the gh-pages branch of this repository. This in turn will make the publication up to date.

The output website which is showing the actual doc with mkdocs : https://opencapi.github.io/omi-doc/

Details can be found documentation user's guide : https://opencapi.github.io/omi-doc/misc/doc-guide/