From 51ab091e446c9aacc603e95e339f89126ef6c0da Mon Sep 17 00:00:00 2001 From: "David A. Wheeler" Date: Mon, 31 Mar 2025 14:25:07 -0400 Subject: [PATCH 1/2] Add SPP hints Add SPP info after discussions with Avishay Balter. Signed-off-by: David A. Wheeler --- docs/spp/Simplest-Possible-Process.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/spp/Simplest-Possible-Process.md b/docs/spp/Simplest-Possible-Process.md index 91e8262e..618fafef 100644 --- a/docs/spp/Simplest-Possible-Process.md +++ b/docs/spp/Simplest-Possible-Process.md @@ -92,6 +92,9 @@ When using markdown: Each heading name should be unique (so the generated ids are unique). You can reference any heading via its ID, e.g., `[text](#ID)`. Here is the [algorithm for determining header IDs](https://kramdown.gettalong.org/converter/html.html). +* If you don't want certain headings to be auto-numbered, after the heading + line add a line saying `{:.nocount}` to make the heading part of that class. + To suppress TOC entriues append the line `{:.no_toc}` after that heading. * If you want a table-of-contents, use `:toc` surrounded by curly braces on its own line. * By default, [GitHub Pages](https://pages.github.com/) uses the @@ -168,6 +171,11 @@ Here's how to do that: This is already configured to comply with the [OpenSSF Brand Guidelines](https://openssf.org/about/brand-guidelines/) such as our preferred fonts and color scheme. +5. Add an `index.md` file inside the `docs/` directory with at least + a little content (possibly linking to important materials). + Without this file (or similar `index.html`), viewing the top-level + domain will present the confusing and technically incorrect error + page saying "There isn't a GitHub Pages site here." ## Rationale for the SPP From 3f96cf7f20ed8790d52882f0f80a5887a84ad227 Mon Sep 17 00:00:00 2001 From: "David A. Wheeler" Date: Mon, 31 Mar 2025 14:33:30 -0400 Subject: [PATCH 2/2] Fix typo Signed-off-by: David A. Wheeler --- docs/spp/Simplest-Possible-Process.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/spp/Simplest-Possible-Process.md b/docs/spp/Simplest-Possible-Process.md index 618fafef..553c681d 100644 --- a/docs/spp/Simplest-Possible-Process.md +++ b/docs/spp/Simplest-Possible-Process.md @@ -94,7 +94,7 @@ When using markdown: Here is the [algorithm for determining header IDs](https://kramdown.gettalong.org/converter/html.html). * If you don't want certain headings to be auto-numbered, after the heading line add a line saying `{:.nocount}` to make the heading part of that class. - To suppress TOC entriues append the line `{:.no_toc}` after that heading. + To suppress TOC entries append the line `{:.no_toc}` after that heading. * If you want a table-of-contents, use `:toc` surrounded by curly braces on its own line. * By default, [GitHub Pages](https://pages.github.com/) uses the