diff options
Diffstat (limited to 'tools/moztreedocs/docs/index.rst')
| -rw-r--r-- | tools/moztreedocs/docs/index.rst | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/tools/moztreedocs/docs/index.rst b/tools/moztreedocs/docs/index.rst new file mode 100644 index 0000000000..bb96a759de --- /dev/null +++ b/tools/moztreedocs/docs/index.rst @@ -0,0 +1,23 @@ +Managing Documentation +====================== + +Documentation is hard. It's difficult to write, difficult to find and always out +of date. That's why we implemented our in-tree documentation system that +underpins firefox-source-docs.mozilla.org. The documentation lives next to the +code that it documents, so it can be updated within the same commit that makes +the underlying changes. + +This documentation is generated via the +`Sphinx <http://sphinx-doc.org/>`_ tool from sources in the tree. + +To build the documentation, run ``mach doc``. Run +``mach help doc`` to see configurable options. + +The review group in Phabricator is ``#firefox-source-docs-reviewers``. + +.. toctree:: + :caption: Documentation + :maxdepth: 2 + :glob: + + * |