From eee3e692e33890204fe66a63beebbaf868eb0bb4 Mon Sep 17 00:00:00 2001
From: Thomas Sauter <thomas.sauter@phoenix-technologies.ch>
Date: Fri, 24 Oct 2025 11:42:06 +0200
Subject: [PATCH] chore: update readme

---
 README.md | 36 +++++++++++++++++++++---------------
 1 file changed, 21 insertions(+), 15 deletions(-)

diff --git a/README.md b/README.md
index 809ffde..47d0f65 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,10 @@ GitHub (forgejo) pipelines and other CI/CD utilities for the frontends Phoenix T
 
 ## .Github Workflows: Build and push containers
 
+### Docker / Container build
+
+Containers are built using dedicated `Dockerfile`s located in the `/docker` directory within each project repository. After the build, the images are pushed to the registry.
+
 ### Tagging
 
 Only tags following the specified patterns will be considered within container tags. Any other patterns will be ignored, ensuring adherence to the established tagging policy.
@@ -15,20 +19,20 @@ Only tags following the specified patterns will be considered within container t
 #### Standalone
 
 - v1.0.0
-- v1.0.0-<anything>
+- v1.0.0-\<anything\>
 
 #### Monorepo
 
 - <project_id>\_v1.0.0
-- <project_id>\_v1.0.0-<anything>
+- <project_id>\_v1.0.0-\<anything\>
 
-Containers are built using dedicated `Dockerfile`s located in the `/docker` directory within each project repository. After the build, the images are pushed to the registry.
+### Pipelines
 
-### `Build`
+#### `Build`
 
 A standard single-repository project with a `package.json` file located at the root, managing dependencies for the entire project.
 
-##### Vars (inherited)
+###### Vars (inherited)
 
 Setuped on org or repo level.
 
@@ -36,13 +40,13 @@ Setuped on org or repo level.
 | ------------ | --------------- | -------- |
 | `IMAGE_PATH` | Image base path | ✓        |
 
-##### Inputs
+###### Inputs
 
 | Key                       | Description                     | Required |
 | ------------------------- | ------------------------------- | -------- |
 | `PACKAGE_WRITER_USERNAME` | User name of the package writer | ✓        |
 
-##### Secrets
+###### Secrets
 
 Note: Secrets must be explicitly passed to workflows, even if they are defined at the repository or organization level. This is due to the way Forgejo handles secrets in workflows.
 
@@ -51,11 +55,11 @@ Note: Secrets must be explicitly passed to workflows, even if they are defined a
 | `PACKAGE_WRITE_TOKEN`       | Accesstoken of the package writer                         | ✓        |
 | `FONTAWESOME_PACKAGE_TOKEN` | Fontawesome Pro library token (Only needed if FA in use ) |          |
 
-### `Build-Monorepo`
+#### `Build-Monorepo`
 
 A monorepo project based on Turborepo, with individual projects located under the `/apps/<PROJECT_ID>` directory.
 
-##### Vars (inherited)
+###### Vars (inherited)
 
 Setuped on org or repo level.
 
@@ -65,14 +69,14 @@ Setuped on org or repo level.
 | `TURBO_TEAM`      | Turbo repo team ID |          |
 | `TURBO_API`       | Turbo repo api url |          |
 
-##### Inputs
+###### Inputs
 
 | Key                       | Description                     | Required |
 | ------------------------- | ------------------------------- | -------- |
 | `PACKAGE_WRITER_USERNAME` | User name of the package writer | ✓        |
 | `PROJECT_ID`              | ID of the projcet               | ✓        |
 
-##### Secrets
+###### Secrets
 
 Note: Secrets must be explicitly passed to workflows, even if they are defined at the repository or organization level. This is due to the way Forgejo handles secrets in workflows.
 
@@ -84,11 +88,13 @@ Note: Secrets must be explicitly passed to workflows, even if they are defined a
 
 ## .Github Workflows: Linting, type checking, code analyzis, dependency tracking
 
-### `Lint`
+### Pipelines
+
+#### `Lint`
 
 Linting, type checking, sonarqube, dependency tracking, any testing
 
-##### Vars (inherited)
+###### Vars (inherited)
 
 Setuped on org or repo level.
 
@@ -98,7 +104,7 @@ Setuped on org or repo level.
 | `TURBO_API`      | Turbo repo api url (only applicable on monorepos) |          |
 | `SONAR_HOST_URL` | Sonarqube Host (required if sonarqube is enabled) |          |
 
-##### Inputs
+###### Inputs
 
 | Key                  | Description                                                                        | Required |
 | -------------------- | ---------------------------------------------------------------------------------- | -------- |
@@ -109,7 +115,7 @@ Setuped on org or repo level.
 | `LINT_SCRIPT`        | Script which runs eslint; default: `yarn run lint`                                 |          |
 | `CHECK_TYPES_SCRIPT` | Script which runs tsc type checking: `yarn run check-types`                        |          |
 
-##### Secrets
+###### Secrets
 
 Note: Secrets must be explicitly passed to workflows, even if they are defined at the repository or organization level. This is due to the way Forgejo handles secrets in workflows.