From 4f12a42841f4e64ec84d81845b7b0a563098dff2 Mon Sep 17 00:00:00 2001 From: Erik Faye-Lund Date: Tue, 30 Mar 2021 12:35:42 +0200 Subject: [PATCH] docs: write basic meta-documentation We were previously completely lacking documentation on how to write documentation. This adds some very basic docs for that. Maybe at some point this could deserve it's own article, but for now this seems enough. This also documents the group-consensus on preferring US English that was reached on the mesa-dev mailing list[1]. [1]: https://lists.freedesktop.org/archives/mesa-dev/2021-March/225023.html Reviewed-by: Jason Ekstrand Part-of: --- docs/submittingpatches.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/submittingpatches.rst b/docs/submittingpatches.rst index cac9786284f..0dee27e555f 100644 --- a/docs/submittingpatches.rst +++ b/docs/submittingpatches.rst @@ -360,6 +360,21 @@ staging/year.quarter branch, not on the year.quarter branch, per the stable branch policy. Assigning the MR to release maintainer for said branch or mentioning them is helpful, but not required. +Documentation patches +--------------------- + +Our documentation is written as `reStructuredText`_ files in the +:file:`docs` folder, and built using `Sphinx`_. + +The preferred language of the documentation is US English. This +doesn't mean that everyone is expected to pay close attention to +the different English variants, but it does mean someome might +suggest a spelling-change, either during review or as a follow-up +merge-request. + +.. _reStructuredText: https://docutils.sourceforge.io/rst.html +.. _Sphinx: https://www.sphinx-doc.org/ + Git tips --------