From ff866fb5b6d8465315b6ba7d59fbe3be5e59aee0 Mon Sep 17 00:00:00 2001 From: Ruth Cheesley Date: Sun, 3 Nov 2024 18:08:40 +0000 Subject: [PATCH] Add note about heading underlines --- docs/contributing/contributing_docs_rst.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/contributing/contributing_docs_rst.rst b/docs/contributing/contributing_docs_rst.rst index 10b2ba10..4568a4af 100644 --- a/docs/contributing/contributing_docs_rst.rst +++ b/docs/contributing/contributing_docs_rst.rst @@ -127,7 +127,9 @@ Mautic uses the following syntax for headings: H6 ^^^ -When you're writing documentation, be sure to nest your headings correctly. This means that you should only use one H1 heading per page, and then nest your headings in the order shown above. This helps to keep the documentation consistent and easy to read. +When you're writing documentation, be sure to nest your headings correctly. This means that you should only use one H1 heading per page, and then nest your headings in the order shown. This helps to keep the documentation consistent and easy to read. + +Also be sure to extend the underline to fit the length of the heading text. This is a requirement of RST syntax and helps to keep the documentation looking neat and tidy. Linking to other pages ======================