From 3bafd04d5e1b9ce22a9c6cd2a145b2adc2f782bd Mon Sep 17 00:00:00 2001
From: Marc Beninca <git@marc.beninca.link>
Date: Mon, 9 Jun 2025 17:52:15 +0200
Subject: [PATCH] readme/toc

---
 readme.md | 68 +++++++++++++++++++++++++++++++++++--------------------
 1 file changed, 44 insertions(+), 24 deletions(-)

diff --git a/readme.md b/readme.md
index 9735e1f..cce4efb 100644
--- a/readme.md
+++ b/readme.md
@@ -5,7 +5,29 @@ from various contexts of CA, DNS, CI and OS / OCI.
 
 ---
 
-## 1 Why
+## Table Of Contents {#toc}
+
+* 1 [Why](#why)
+* 2 [How](#how)
+  * 2.1 [Group environment variables](#how-variables)
+  * 2.2 [Workflow files](#how-workflows)
+  * 2.3 [Integration & Deployment](#how-actions)
+* 3 [What](#what)
+  * 3.1 [Features](#what-features)
+  * 3.2 [Environment variables](#what-variables)
+  * 3.3 [Operating Systems containers](#what-systems)
+* 4 [Who](#who)
+* 5 [Where](#where)
+  * 5.1 [Chat](#where-chat)
+  * 5.2 [Repo](#where-repo)
+  * 5.3 [Site](#where-site)
+* 6 [When](#when)
+  * 6.1 [Release tasks](#when-release)
+  * 6.2 [Further tasks](#when-further)
+
+---
+
+## 1 [Why](#toc) {#why}
 
 Project workflows can occur in:
 * an online or offline context, dealing with custom CA & DNS servers
@@ -17,11 +39,11 @@ What if there was a unified way to do so?
 
 ---
 
-## 2 How
+## 2 [How](#toc) {how}
 
 Picture it…
 
-### 2.1 Group environment variables
+### 2.1 [Group environment variables](#how) {#how-variables}
 
 * numbered
   * Certificate Authority armored certificates
@@ -37,12 +59,12 @@ Picture it…
 * SSH key & hosts for deployments
 * a standalone POSIX shell script payload
 
-### 2.2 Workflow files
+### 2.2 [Workflow files](#how) {#how-workflows}
 
 * calling the POSIX shell script payload as their very first step
 * using a unified YAML syntax made of actions implemented in Python
 
-### 2.3 Integration & Deployment
+### 2.3 [Integration & Deployment](#how) {#how-actions}
 
 #### Shell
 
@@ -76,9 +98,9 @@ Picture it…
 
 ---
 
-## 3 What
+## 3 [What](#toc) {#what}
 
-### 3.1 Features
+### 3.1 [Features](#what) {#what-features}
 
 Handle project workflows in a unified way:
 
@@ -107,7 +129,7 @@ Handle project workflows in a unified way:
 | Rocky    | ☑ 9                    | ☑ 8                    |
 | Ubuntu   | ☑ Noble (24.04)        | ☐ Jammy (22.04)        |
 
-### 3.2 Environment variables
+### 3.2 [Environment variables](#what) {#what-variables}
 
 | Variable          | Description              | Default                         |
 |:------------------|:-------------------------|:--------------------------------|
@@ -134,7 +156,7 @@ Handle project workflows in a unified way:
 | SPCD_URL_ROCKY    | Rocky repository URL     | https://dl.rockylinux.org       |
 | SPCD_URL_UBUNTU   | Ubuntu repository URL    | https://ubuntu.mirrors.ovh.net  |
 
-### 3.3 Operating Systems containers
+### 3.3 [Operating Systems containers](#what) {#what-systems}
 
 #### Latest
 
@@ -166,36 +188,34 @@ Handle project workflows in a unified way:
 
 ---
 
-## 4 Who
+## 4 [Who](#toc) {#who}
 
-### Author
-
-* [Marc Beninca](https://forge.rwx.work/marc.beninca)
+* Author: [Marc Beninca](https://forge.rwx.work/marc.beninca)
 
 ---
 
-## 5 Where
+## 5 [Where](#toc) {#where}
 
-### Chat
+### 5.1 [Chat](#where) {#where-chat}
 
 * [Discord](https://discord.com/channels/983145051985154108/1255894420092485652)
 * [IRC](ircs://irc.libera.chat/#spcd)
 
-### Forge
+### 5.2 [Repo](#where) {#where-repo}
 
-* [Repository](https://forge.rwx.work/rwx.work/spcd)
-* [RSS](https://forge.rwx.work/rwx.work/spcd.rss)
-* [Workflows](https://forge.rwx.work/rwx.work/spcd/actions)
+* [Code](https://forge.rwx.work/rwx.work/spcd)
+* [Feed](https://forge.rwx.work/rwx.work/spcd.rss)
+* [Actions](https://forge.rwx.work/rwx.work/spcd/actions)
 
-### Deployment
+### 5.3 [Site](#where) {#where-site}
 
-* [Site](https://spcd.rwx.work)
+* [Web](https://spcd.rwx.work)
 
 ---
 
-## 6 When
+## 6 [When](#toc) {#when}
 
-### 6.1 Tasks for a 1st stable release
+### 6.1 [Release tasks](#when) {#when-release}
 
 #### Documentation
 
@@ -265,7 +285,7 @@ Handle project workflows in a unified way:
 * try git repo url variable first for shunit
 * test
 
-### 6.2 Task stack
+### 6.2 [Further tasks](#when) {#when-further}
 
 * automate versions fetching
 * gource, xvfb, xauth