diff --git a/source/clear-linux/reference/collaboration/collaboration.rst b/source/clear-linux/reference/collaboration/collaboration.rst index e4a101c1..823c2471 100644 --- a/source/clear-linux/reference/collaboration/collaboration.rst +++ b/source/clear-linux/reference/collaboration/collaboration.rst @@ -8,8 +8,7 @@ be improved? Help us out by contributing! If you haven't contributed before, take a moment to review our `Contribution guidelines`_. Do you have questions about the documentation that were not answered by these -guidelines? Send your question to the `mailing list`_ at: -dev@lists.clearlinux.org. +guidelines? Send your question to the `mailing list`_. Contribution guidelines *********************** @@ -21,9 +20,8 @@ readable documentation. .. toctree:: :maxdepth: 1 - Writing guide describes the style we use to keep our documents clear and concise. - Structure and formatting guide explains how we use reStructuredText and Sphinx. - GitHub documentation repository shows our document organization. + Writing guide: Describes the style we use to keep our documents clear and concise. + Structure and formatting guide: Explains how we organize and format content, using reStructuredText and Sphinx. How to contribute ***************** diff --git a/source/clear-linux/reference/collaboration/structure-formatting.rst b/source/clear-linux/reference/collaboration/structure-formatting.rst index d97e2937..dedb94d9 100644 --- a/source/clear-linux/reference/collaboration/structure-formatting.rst +++ b/source/clear-linux/reference/collaboration/structure-formatting.rst @@ -158,10 +158,10 @@ Use our quick reference for the most commonly used inline text elements: +--------------------------------+---------------------------------------+-----------------------------+ | **Element** | **Convention** | **reST/Sphinx** | +--------------------------------+---------------------------------------+-----------------------------+ -| Acronyms | First instance, display definition as | Use the ``:abbr:`` role. | -| | flyover text in this format: | | -| | ``:abbr:`Acronym (Definition)``` | | -| | For subsequent uses, use the acronym. | | +| Acronyms | Define acronym when first used. After | Use the ``:abbr:`` role, in | +| | first use and definition, use the | the following format: | +| | acronym only. | | +| | | ``:abbr:`Acronym (Def)``` | +--------------------------------+---------------------------------------+-----------------------------+ | Bundle names | Bold | Use the ``:command:`` role. | +--------------------------------+---------------------------------------+-----------------------------+