From 7ec56c9450ae8982c20daae03e33176e9b9cd374 Mon Sep 17 00:00:00 2001 From: Paul Latzelsperger <43503240+paullatzelsperger@users.noreply.github.com> Date: Mon, 26 Aug 2024 12:53:01 +0200 Subject: [PATCH] chore(doc): fix TOC entries (#204) --- .../for-contributors/contributor-handbook.md | 12 ++++---- .../for-contributors/control-plane/json-ld.md | 10 +++---- .../control-plane/programming-primitives.md | 28 +++++++++---------- .../control-plane/protocol-extensions.md | 9 +++--- 4 files changed, 27 insertions(+), 32 deletions(-) diff --git a/developer/wip/for-contributors/contributor-handbook.md b/developer/wip/for-contributors/contributor-handbook.md index 0d4063e0..61d2db3f 100644 --- a/developer/wip/for-contributors/contributor-handbook.md +++ b/developer/wip/for-contributors/contributor-handbook.md @@ -16,16 +16,16 @@ * [2.6 Service layers](#26-service-layers) * [2.7 Policy Monitor](#27-policy-monitor) * [2.8 Protocol extensions (DSP)](#28-protocol-extensions-dsp) - * [3. (Postgre-)SQL persistence](#3-postgre-sql-persistence) + * [3. (Postgre-)SQL persistence](#3-postgre-sql-persistence) * [4. The data plane](#4-the-data-plane) * [4.1 Data plane signaling](#41-data-plane-signaling) - * [4.2 Data plane self-registration](#42-data-plane-self-registration) - * [4.3 Public API authentication](#43-public-api-authentication) - * [4.4 Writing a custom data plane extension (sink/source)](#44-writing-a-custom-data-plane-extension-sinksource) - * [4.5 Writing a custom data plane (using only DPS)](#45-writing-a-custom-data-plane-using-only-dps) + * [4.2 Writing a custom data plane extension (sink/source)](#42-writing-a-custom-data-plane-extension-sinksource) + * [4.3 Writing a custom data plane (using only DPS)](#43-writing-a-custom-data-plane-using-only-dps) * [5. Development best practices](#5-development-best-practices) * [5.1 Writing Unit-, Component-, Integration-, Api-, EndToEnd-Tests](#51-writing-unit--component--integration--api--endtoend-tests) - * [5.1 Other best practices](#51-other-best-practices) + * [5.1 Coding best practices](#51-coding-best-practices) + * [5.2 Testing best practices](#52-testing-best-practices) + * [5.3 Other best practices](#53-other-best-practices) * [6. Further concepts](#6-further-concepts) * [6.2 Autodoc](#62-autodoc) * [6.3 Adapting the Gradle build](#63-adapting-the-gradle-build) diff --git a/developer/wip/for-contributors/control-plane/json-ld.md b/developer/wip/for-contributors/control-plane/json-ld.md index f19ba520..1d1552cd 100644 --- a/developer/wip/for-contributors/control-plane/json-ld.md +++ b/developer/wip/for-contributors/control-plane/json-ld.md @@ -1,13 +1,11 @@ # JSON-LD in EDC - * [JSON-LD in EDC](#json-ld-in-edc) - * [1. JSON-LD in EDC](#1-json-ld-in-edc) - * [1.1 Compact IRI](#11-compact-iri) - * [1.2 Custom Remote Context](#12-custom-remote-context) - * [1.1 JSON-LD Validation](#11-json-ld-validation) - + * [1. JSON-LD in EDC](#1-json-ld-in-edc) + * [1.1 Compact IRI](#11-compact-iri) + * [1.2 Custom Remote Context](#12-custom-remote-context) + * [1.1 JSON-LD Validation](#11-json-ld-validation) Here is a simple example taken from [json-ld.org](https://json-ld.org) diff --git a/developer/wip/for-contributors/control-plane/programming-primitives.md b/developer/wip/for-contributors/control-plane/programming-primitives.md index f78de62a..bf10f7c8 100644 --- a/developer/wip/for-contributors/control-plane/programming-primitives.md +++ b/developer/wip/for-contributors/control-plane/programming-primitives.md @@ -1,22 +1,20 @@ # Programming Primitives - * [Programming Primitives](#programming-primitives) - * [1 State machines](#1-state-machines) - * [1.1 Batch-size, sorting and tick-over timeout](#11-batch-size-sorting-and-tick-over-timeout) - * [1.2 Database-level locking](#12-database-level-locking) - * [2. Transformers](#2-transformers) - * [2.1 Basic Serialization and Deserialization](#21-basic-serialization-and-deserialization) - * [2.1 Transformer context](#21-transformer-context) - * [2.2 Segmented transformer registries](#22-segmented-transformer-registries) - * [2.3 Reporting transformation errors](#23-reporting-transformation-errors) - * [3. Token generation and decorators](#3-token-generation-and-decorators) - * [4. Token validation and rules](#4-token-validation-and-rules) - * [4.1 Public Key Resolvers](#41-public-key-resolvers) - * [4.2 Validation Rules](#42-validation-rules) - * [4.3 Validation Rules Registry](#43-validation-rules-registry) - + * [1 State machines](#1-state-machines) + * [1.1 Batch-size, sorting and tick-over timeout](#11-batch-size-sorting-and-tick-over-timeout) + * [1.2 Database-level locking](#12-database-level-locking) + * [2. Transformers](#2-transformers) + * [2.1 Basic Serialization and Deserialization](#21-basic-serialization-and-deserialization) + * [2.1 Transformer context](#21-transformer-context) + * [2.2 Segmented transformer registries](#22-segmented-transformer-registries) + * [2.3 Reporting transformation errors](#23-reporting-transformation-errors) + * [3. Token generation and decorators](#3-token-generation-and-decorators) + * [4. Token validation and rules](#4-token-validation-and-rules) + * [4.1 Public Key Resolvers](#41-public-key-resolvers) + * [4.2 Validation Rules](#42-validation-rules) + * [4.3 Validation Rules Registry](#43-validation-rules-registry) ## 1 State machines diff --git a/developer/wip/for-contributors/control-plane/protocol-extensions.md b/developer/wip/for-contributors/control-plane/protocol-extensions.md index ca5d32ef..83607e85 100644 --- a/developer/wip/for-contributors/control-plane/protocol-extensions.md +++ b/developer/wip/for-contributors/control-plane/protocol-extensions.md @@ -3,13 +3,12 @@ * [Protocol Extensions](#protocol-extensions) * [1. RemoteMessage](#1-remotemessage) - * [1.1 Delivering messages with RemoteMessageDispatcher](#11-delivering-messages-with-remotemessagedispatcher) - * [1.2 Handling incoming messages with protocol services](#12-handling-incoming-messages-with-protocol-services) - * [2. DSP protocol](#2-dsp-protocol-implementation) + * [1.1 Delivering messages with RemoteMessageDispatcher](#11-delivering-messages-with-remotemessagedispatcher) + * [1.2 Handling incoming messages with protocol services](#12-handling-incoming-messages-with-protocol-services) + * [2. DSP protocol implementation](#2-dsp-protocol-implementation) * [2.1 `RemoteMessage` handlers](#21-remotemessage-handlers) * [2.2 HTTP endpoints](#22-http-endpoints) - * [2.3 `RemoteMessage` transformers](#22-remotemessage-transformers) - + * [2.2 `RemoteMessage` transformers](#22-remotemessage-transformers)