arch-api-design-guidelines

Some guidelines as a documentation project that aims to define a set of rules and principles for designing APIs.

Online documentation

Getting started

To install the documentation engine

pip install mkdocs

To serve the documentation

mkdocs serve

To build the documentation

mkdocs build