Skip to content

Commit d06c917

Browse files
committed
Changed the method of creating top-level headings
Use an underline only, with no overline on page titles. This makes the rst include statement easier and more straight forward to use, while maintaining structure and appearance.
1 parent 8ea3bf2 commit d06c917

File tree

4 files changed

+2
-9
lines changed

4 files changed

+2
-9
lines changed

source/process/sg_document-structure.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
==================
21
Document structure
32
==================
43

source/process/sg_grammar-spelling-mechanics.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
================================
21
Grammar, spelling, and mechanics
32
================================
43

source/process/sg_mattermost-doc-style.rst

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,5 @@ The Mattermost documentation must be of high quality. It must be accurate and cl
1212
:backlinks: top
1313

1414
.. include:: sg_document-structure.rst
15-
:start-line: 1
1615
.. include:: sg_grammar-spelling-mechanics.rst
17-
:start-line: 1
1816
.. include:: sg_rest_markup.rst
19-
:start-line: 1

source/process/sg_rest_markup.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
=============================
21
Using reStructuredText Markup
32
=============================
43

@@ -13,15 +12,14 @@ Use the following markup conventions in Mattermost documentation:
1312
Page titles
1413
-----------
1514

16-
For page titles, use an overline and an underline. Use the = character. For example:
15+
For page titles, use the = character for the title underline, with no overline. For example:
1716

1817
.. code-block:: none
1918
20-
=============================
2119
Using reStructuredText Markup
2220
=============================
2321
24-
Unlike Markdown, overlines and underlines in reStructuredText must be at least as long as the title text.
22+
Unlike Markdown, underlines in reStructuredText must be at least as long as the title text.
2523

2624
Section titles
2725
--------------

0 commit comments

Comments
 (0)