From fe5c9fda4bcb650fdbac4d6c1e84255b1e1ea6a7 Mon Sep 17 00:00:00 2001 From: Jake Zimmerman Date: Tue, 17 Dec 2019 12:21:50 -0800 Subject: [PATCH] Update style guide w.r.t. headings (#2354) --- website/style-guide.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/website/style-guide.md b/website/style-guide.md index 25f8aedffb3..8aafa600a20 100644 --- a/website/style-guide.md +++ b/website/style-guide.md @@ -31,12 +31,22 @@ - Don't e.g. use `foo` to mean a local variable, or `f` to mean an arbitrary method, or `A` mean an module. -- All non-title headings should be sentence case, always. +- All headings (but not the page title) should be sentence case, always. + - ❌ Some Non-Title Heading - ✅ Some non-title heading -- All non-doc titles should be sentence case - - see above - - this includes blog posts + - All doc titles should be title case + - ❌ Some page title - ✅ Some Page Title + +- All non-doc titles should be sentence case + + - see above + - this includes blog posts + +- Never use `#` for headings. Start with `##` and go down. + - Prefer only two-levels of nesting (`##` and `###`) + - This means avoid `####` except in rare circumstances. Usually `####` can be + avoided by using more `###` levels.