Documentation

Zanata uses Readthedocs for its client and server documentation (http://readthedocs.org). Documentation is written in Markdown and it's located under the docs directory in the server and client repositories. The documentation menu is also driven by the /mkdocs.yml file.

To preview the documentation while it's being worked on, you must install Mkdocs (http://www.mkdocs.org/#installation) and then run (at the root of the repository directory):

$ mkdocs serve

This will start a local documentation server and it will refresh the documentation as it's changed.

For the latest publicly available documentation, please visit:

http://zanata.readthedocs.org/en/latest or http://docs.zanata.org/en/release/