Document Guide ============== At present we use ``reStructureText`` for project docs and ``Markdown`` for blog, spec docs. To write docs more easily and style consistently, document writers must follow some guidelines below. It's expected that everyone should understand this guide to produce good documents. Style Guide ----------- .. todo:: Need to have docs style guide here reStructuredText Writing ------------------------ .. todo:: Need to have docs guide here Markdown Writing ---------------- .. todo:: find good live markdown libs, for example: - https://github.com/shime/livedown - https://github.com/mobily/markdown-live References ---------- - http://docutils.sourceforge.net/rst.html - http://sphinx-doc.org/ - http://daringfireball.net/projects/markdown/syntax - https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet .. _restview: https://mg.pov.lt/restview/