fix: permalinks in headers

norberttech · norberttech · commit cae7339a93c1 · 2025-12-02T17:01:50.000+01:00
Added table of contents to documentation pages
diff --git a/documentation/adrs.md b/documentation/adrs.md
@@ -1,5 +1,7 @@
 # Architecture Decision Record
 
+[TOC]
+
 # What are ADRs?
 Architecture Decision Records (ADRs) are structured documents that capture significant architectural decisions made during the development of this project. 
 
diff --git a/documentation/adrs/extension-points.md b/documentation/adrs/extension-points.md
@@ -1,5 +1,7 @@
 # Extension Points
 
+[TOC]
+
 Proposed by: @norberttech  
 Date: 2025-01-09
 
diff --git a/documentation/adrs/static-analysis-baseline.md b/documentation/adrs/static-analysis-baseline.md
@@ -1,5 +1,7 @@
 # Static Analysis Baseline
 
+[TOC]
+
 Proposed by: @norberttech
 Date: 2025-01-07
 
diff --git a/documentation/adrs/template.md b/documentation/adrs/template.md
@@ -1,5 +1,7 @@
 # [Decision Title]
 
+[TOC]
+
 Proposed by: @author_github_username
 Date: YYYY-MM-DD
 
diff --git a/documentation/components/adapters/chartjs.md b/documentation/components/adapters/chartjs.md
@@ -4,6 +4,8 @@
 - [📚API Reference](/documentation/api/adapter/chartjs)
 - [📁Files](/documentation/api/adapter/chartjs/indices/files.html)
 
+[TOC]
+
 Flow PHP's Adapter ChartJS is a meticulously designed library intended to seamlessly integrate ChartJS within your ETL (
 Extract, Transform, Load) workflows. This adapter is pivotal for developers seeking to effortlessly render and interact
 with charts, ensuring a visually engaging and insightful data transformation journey. By utilizing the Adapter ChartJS
diff --git a/documentation/components/adapters/csv.md b/documentation/components/adapters/csv.md
@@ -4,6 +4,8 @@
 - [📚API Reference](/documentation/api/adapter/csv)
 - [📁Files](/documentation/api/adapter/csv/indices/files.html)
 
+[TOC]
+
 Flow PHP's Adapter CSV is a proficient library crafted to enable seamless interaction with CSV data within your ETL (
 Extract, Transform, Load) workflows. This adapter is indispensable for developers aiming to effortlessly extract from or
 load data into CSV formats, ensuring a smooth and reliable data transformation journey. By employing the Adapter CSV
diff --git a/documentation/components/adapters/doctrine.md b/documentation/components/adapters/doctrine.md
@@ -4,6 +4,8 @@
 - [📚API Reference](/documentation/api/adapter/doctrine)
 - [📁Files](/documentation/api/adapter/doctrin/indices/files.html)
 
+[TOC]
+
 Flow PHP's Adapter Doctrine is an adept library designed to seamlessly integrate Doctrine ORM within your ETL (Extract,
 Transform, Load) workflows. This adapter is crucial for developers seeking to effortlessly interact with databases using
 Doctrine ORM, ensuring a streamlined and reliable data transformation process. By harnessing the Adapter Doctrine
diff --git a/documentation/components/adapters/elasticsearch.md b/documentation/components/adapters/elasticsearch.md
@@ -4,6 +4,8 @@
 - [📚API Reference](/documentation/api/adapter/elasticsearch)
 - [📁Files](/documentation/api/adapter/elasticsearch/indices/files.html)
 
+[TOC]
+
 Flow PHP's Adapter Elasticsearch is a sophisticated library devised to facilitate seamless interaction with
 Elasticsearch within your ETL (Extract, Transform, Load) workflows. This adapter is essential for developers aiming to
 effortlessly extract from or load data into Elasticsearch, ensuring a streamlined and reliable data transformation
diff --git a/documentation/components/adapters/excel.md b/documentation/components/adapters/excel.md
@@ -4,6 +4,8 @@
 - [📚API Reference](/documentation/api/adapter/excel)
 - [📁Files](/documentation/api/adapter/excel/indices/files.html)
 
+[TOC]
+
 Flow PHP's Adapter Excel is a comprehensive library engineered to enable smooth interactions with Excel
 within your ETL (Extract, Transform, Load) workflows. This adapter is indispensable for developers looking to seamlessly
 extract from or load data into Excel, ensuring a coherent and reliable data transformation journey. By
diff --git a/documentation/components/adapters/google-sheet.md b/documentation/components/adapters/google-sheet.md
@@ -4,6 +4,8 @@
 - [📚API Reference](/documentation/api/adapter/google-sheet)
 - [📁Files](/documentation/api/adapter/google-sheet/indices/files.html)
 
+[TOC]
+
 Flow PHP's Adapter Google Sheet is a comprehensive library engineered to enable smooth interactions with Google Sheets
 within your ETL (Extract, Transform, Load) workflows. This adapter is indispensable for developers looking to seamlessly
 extract from or load data into Google Sheets, ensuring a coherent and reliable data transformation journey. By
diff --git a/documentation/components/adapters/http.md b/documentation/components/adapters/http.md
@@ -4,6 +4,8 @@
 - [📚API Reference](/documentation/api/adapter/http)
 - [📁Files](/documentation/api/adapter/http/indices/files.html)
 
+[TOC]
+
 Flow PHP's Adapter HTTP is a finely crafted library designed to enable seamless interaction with HTTP protocols within
 your ETL (Extract, Transform, Load) workflows. This adapter is vital for developers aiming to effortlessly send or
 receive HTTP requests, ensuring a streamlined and reliable data transformation process. By harnessing the Adapter HTTP
diff --git a/documentation/components/adapters/json.md b/documentation/components/adapters/json.md
@@ -4,6 +4,8 @@
 - [📚API Reference](/documentation/api/adapter/json)
 - [📁Files](/documentation/api/adapter/json/indices/files.html)
 
+[TOC]
+
 Flow PHP's Adapter JSON is a meticulously engineered library aimed at facilitating seamless interactions with JSON data
 within your ETL (Extract, Transform, Load) workflows. This adapter is paramount for developers seeking to effortlessly
 extract from or load data into JSON formats, ensuring a fluid and reliable data transformation experience. By utilizing
diff --git a/documentation/components/adapters/logger.md b/documentation/components/adapters/logger.md
@@ -4,6 +4,8 @@
 - [📚API Reference](/documentation/api/adapter/logger)
 - [📁Files](/documentation/api/adapter/logger/indices/files.html)
 
+[TOC]
+
 ETL Adapter that provides PSR Logger support for ETL.
 
 ## Installation
diff --git a/documentation/components/adapters/meilisearch.md b/documentation/components/adapters/meilisearch.md
@@ -4,6 +4,8 @@
 - [📚API Reference](/documentation/api/adapter/meilisearch)
 - [📁Files](/documentation/api/adapter/meilisearch/indices/files.html)
 
+[TOC]
+
 Flow PHP's Adapter MeiliSearch is a refined library designed to seamlessly integrate MeiliSearch capabilities within
 your ETL (Extract, Transform, Load) workflows. This adapter is essential for developers seeking to effortlessly interact
 with MeiliSearch, a powerful, fast, and open-source search engine, thereby enhancing the search and indexing
diff --git a/documentation/components/adapters/text.md b/documentation/components/adapters/text.md
@@ -4,6 +4,8 @@
 - [📚API Reference](/documentation/api/adapter/text)
 - [📁Files](/documentation/api/adapter/text/indices/files.html)
 
+[TOC]
+
 Flow PHP's Adapter Text is a meticulously crafted library dedicated to enabling seamless handling of text data within
 your ETL (Extract, Transform, Load) workflows. This adapter is pivotal for developers seeking to effortlessly extract
 from or load data into text formats, ensuring a fluid and dependable data transformation experience. By employing the
diff --git a/documentation/components/adapters/xml.md b/documentation/components/adapters/xml.md
@@ -4,6 +4,8 @@
 - [📚API Reference](/documentation/api/adapter/xml)
 - [📁Files](/documentation/api/adapter/xml/indices/files.html)
 
+[TOC]
+
 Flow PHP's Adapter XML is a dedicated library engineered to facilitate seamless interactions with XML data within your
 ETL (Extract, Transform, Load) processes. This adapter empowers developers to effortlessly extract from and load data
 into XML formats, ensuring a smooth and reliable data transformation journey. By harnessing the Adapter XML library,
diff --git a/documentation/components/bridges/filesystem-azure-bridge.md b/documentation/components/bridges/filesystem-azure-bridge.md
@@ -4,6 +4,8 @@
 - [📚API Reference](/documentation/api/bridge/filesystem/azure)
 - [📁Files](/documentation/api/bridge/filesystem/azure/indices/files.html)
 
+[TOC]
+
 The Filesystem Azure Bridge is a bridge that allows you to use the Azure Blob Storage as a filesystem in your application.
 
 ## Installation
diff --git a/documentation/components/bridges/monolog-http-bridge.md b/documentation/components/bridges/monolog-http-bridge.md
@@ -4,6 +4,8 @@
 - [📚API Reference](/documentation/api/bridge/monolog/http)
 - [📁Files](/documentation/api/bridge/monolog/http/indices/files.html)
 
+[TOC]
+
 Monolog HTTP Bridge is a package that iterates through LogRecord context and normalizes all instances of `Request` and `Response` from [PSR7](https://www.php-fig.org/psr/psr-7/).
 
 ## Installation
diff --git a/documentation/components/bridges/openapi-specification-bridge.md b/documentation/components/bridges/openapi-specification-bridge.md
@@ -4,6 +4,8 @@
 - [📚API Reference](/documentation/api/bridge/openapi/specification)
 - [📁Files](/documentation/api/bridge/openapi/specification/indices/files.html)
 
+[TOC]
+
 This package provides bidirectional conversion between Flow PHP schemas and OpenAPI 3.0 specifications. 
 It enables you to generate OpenAPI documentation from Flow schemas and vice versa, facilitating API-first development and documentation workflows.
 
diff --git a/documentation/components/bridges/symfony-http-foundation-bridge.md b/documentation/components/bridges/symfony-http-foundation-bridge.md
@@ -4,6 +4,8 @@
 - [📚API Reference](/documentation/api/bridge/symfony/http-foundation)
 - [📁Files](/documentation/api/bridge/symfony/http-foundation/indices/files.html)
 
+[TOC]
+
 Http Foundation Bridge provides seamless integration between Symfony Http Foundation and Flow PHP.
 
 `FlowStreamedResponse` is a Symfony Streamed Response that can:
diff --git a/documentation/components/cli/docs.md b/documentation/components/cli/docs.md
@@ -4,6 +4,8 @@
 - [📚API Reference](/documentation/api/cli)
 - [📁Files](/documentation/api/cli/indices/files.html)
 
+[TOC]
+
 ## Installation
 
 ```shell
diff --git a/documentation/components/core/aggregations.md b/documentation/components/core/aggregations.md
@@ -2,6 +2,8 @@
 
 - [⬅️️ Back](/documentation/components/core/group-by.md)
 
+[TOC]
+
 Each group created by `groupBy` function can be aggregated using one of the aggregation functions.
 
 ## Aggregation functions
diff --git a/documentation/components/core/batch-processing.md b/documentation/components/core/batch-processing.md
@@ -2,6 +2,8 @@
 
 - [⬅️️ Back](/documentation/components/core/core.md)
 
+[TOC]
+
 Batch processing controls how data flows through the DataFrame pipeline, affecting memory usage and performance.
 
 ## Batch Size Control
diff --git a/documentation/components/core/constraints.md b/documentation/components/core/constraints.md
@@ -2,6 +2,8 @@
 
 - [⬅️️ Back](/documentation/components/core/core.md)
 
+[TOC]
+
 Data constraints allow you to apply business rules and data integrity checks to ensure data quality during processing. When a constraint is violated, a `ConstraintViolationException` is thrown with details about the violating row.
 
 ## Unique Constraints
diff --git a/documentation/components/core/core.md b/documentation/components/core/core.md
@@ -4,6 +4,8 @@
 - [📚API Reference](/documentation/api/core)
 - [📁Files](/documentation/api/core/indices/files.html)
 
+[TOC]
+
 A Data Frame is the core component of Flow PHP's ETL framework. It represents a structured collection of tabular data that can be processed, transformed, and loaded efficiently. Think of it as a programmable spreadsheet that can handle large datasets with minimal memory footprint.
 
 ## Key Features
diff --git a/documentation/components/core/data-manipulation.md b/documentation/components/core/data-manipulation.md
@@ -2,6 +2,8 @@
 
 - [⬅️️ Back](/documentation/components/core/core.md)
 
+[TOC]
+
 DataFrame provides several methods for manipulating data structures and values within your datasets. These operations
 allow you to add, modify, cast, and clean data efficiently.
 
diff --git a/documentation/components/core/data-retrieval.md b/documentation/components/core/data-retrieval.md
@@ -2,6 +2,8 @@
 
 - [⬅️️ Back](/documentation/components/core/core.md)
 
+[TOC]
+
 DataFrame provides several methods for retrieving processed data. These methods are trigger operations that execute the
 entire pipeline.
 
diff --git a/documentation/components/core/execution-mode.md b/documentation/components/core/execution-mode.md
@@ -1,5 +1,7 @@
 # Execution Mode
 
+[TOC]
+
 Flow DataFrame supports two execution modes that control how scalar functions handle validation errors:
 
 - **LENIENT** (default): Validation errors are ignored, processing continues with fallback values (null, false, [], '')
diff --git a/documentation/components/core/join.md b/documentation/components/core/join.md
@@ -2,6 +2,8 @@
 
 - [⬅️️ Back](/documentation/components/core/core.md)
 
+[TOC]
+
 Joining two data frames is a common operation in data processing that combines data from two different sources. Flow PHP
 implements joins using a **hash join algorithm** that creates a hash table from the right DataFrame and probes it with
 rows from the left DataFrame.
diff --git a/documentation/components/core/offset.md b/documentation/components/core/offset.md
@@ -2,6 +2,8 @@
 
 - [⬅️️ Back](/documentation/components/core/core.md)
 
+[TOC]
+
 The offset operation skips a specified number of rows from the beginning of the dataset, commonly used for pagination
 and data sampling.
 
diff --git a/documentation/components/core/partitioning.md b/documentation/components/core/partitioning.md
@@ -2,6 +2,8 @@
 
 - [⬅️️ Back](/documentation/components/core/core.md)
 
+[TOC]
+
 Partitioning divides data into logical groups based on column values, enabling more efficient processing of large datasets and reducing memory usage.
 
 ## Basic Partitioning
diff --git a/documentation/components/core/pivot.md b/documentation/components/core/pivot.md
@@ -2,6 +2,8 @@
 
 - [⬅️️ Back](/documentation/components/core/core.md)
 
+[TOC]
+
 Pivot operations transform data from a long format to a wide format by rotating column values into column headers. This
 is commonly used for creating cross-tabular reports and summary tables.
 
diff --git a/documentation/components/core/rename.md b/documentation/components/core/rename.md
@@ -2,6 +2,8 @@
 
 - [⬅️️ Back](/documentation/components/core/core.md)
 
+[TOC]
+
 DataFrame provides several methods for renaming entries (columns) in your data. These operations are lazy and don't execute until a trigger operation is called.
 
 ## Single Column Rename
diff --git a/documentation/components/core/retry.md b/documentation/components/core/retry.md
@@ -3,6 +3,8 @@
 - [⬅️ Back](core.md)
 - [📚 API Reference](/documentation/api/core)
 
+[TOC]
+
 The Flow ETL framework provides robust retry mechanisms to handle transient failures during data loading operations.
 This is essential for building resilient data pipelines that can recover from temporary network issues, database
 connection problems, or resource availability conflicts.
diff --git a/documentation/components/core/save-mode.md b/documentation/components/core/save-mode.md
@@ -1,5 +1,7 @@
 # Save Mode
 
+[TOC]
+
 Flow DataFrame provides four save modes that control how data is written when the destination file or path already exists:
 
 - **ExceptionIfExists** (default): Throws an exception if the destination already exists
diff --git a/documentation/components/core/schema.md b/documentation/components/core/schema.md
@@ -2,6 +2,8 @@
 
 - [⬅️️ Back](/documentation/components/core/core.md)
 
+[TOC]
+
 Schema defines the structure and validation rules for DataFrame data. It provides type safety, data validation, and
 metadata management for your data processing pipelines.
 
diff --git a/documentation/components/core/select-drop.md b/documentation/components/core/select-drop.md
@@ -2,6 +2,8 @@
 
 - [⬅️️ Back](/documentation/components/core/core.md)
 
+[TOC]
+
 ## Select
 
 To quickly select only relevant entries use Rows `DataFrame::select`
diff --git a/documentation/components/core/transformations.md b/documentation/components/core/transformations.md
@@ -2,6 +2,8 @@
 
 - [⬅️️ Back](/documentation/components/core/core.md)
 
+[TOC]
+
 ## Introduction
 
 Transformations are a powerful abstraction in Flow PHP that allow you to modify DataFrames in a composable and reusable
diff --git a/documentation/components/core/window-functions.md b/documentation/components/core/window-functions.md
@@ -2,6 +2,8 @@
 
 - [⬅️️ Back](/documentation/components/core/core.md)
 
+[TOC]
+
 Window functions are a special type of function that perform calculations on a set of rows that are related to the current row. 
 Unlike regular aggregate functions, use of a window function does not cause rows to become grouped into a single output row — the rows retain their separate identities. 
 Behind the scenes, the window function is able to access more than just the current row of the query result.
diff --git a/documentation/components/extensions/pg-query-ext.md b/documentation/components/extensions/pg-query-ext.md
@@ -2,6 +2,8 @@
 
 - [⬅️️ Back](/documentation/introduction.md)
 
+[TOC]
+
 A compiled PHP extension for PostgreSQL query parsing using [libpg_query](https://github.com/pganalyze/libpg_query).
 
 This extension provides low-level functions for parsing PostgreSQL SQL queries. For a higher-level, object-oriented interface with strongly-typed AST nodes, see the [pg-query library](/documentation/components/libs/pg-query.md).
diff --git a/documentation/components/libs/array-dot.md b/documentation/components/libs/array-dot.md
@@ -4,6 +4,8 @@
 - [📚API Reference](/documentation/api/lib/array-dot)
 - [📁Files](/documentation/api/lib/array-dot/indices/files.html)
 
+[TOC]
+
 Flow PHP's Array Dot is a proficient library engineered to enhance array handling and manipulation in PHP. This library
 embodies a practical solution for accessing and manipulating array elements using dot notation, facilitating a more
 readable and maintainable code base. By leveraging the dot notation, developers can effortlessly traverse nested arrays
diff --git a/documentation/components/libs/azure-sdk.md b/documentation/components/libs/azure-sdk.md
@@ -4,6 +4,8 @@
 - [📚API Reference](/documentation/api/lib/azure-sdk)
 - [📁Files](/documentation/api/lib/azure-sdk/indices/files.html)
 
+[TOC]
+
 Simple, lightweight, dependency-free and efficient Azure SDK for PHP.
 
 ## Installation
diff --git a/documentation/components/libs/doctrine-dbal-bulk.md b/documentation/components/libs/doctrine-dbal-bulk.md
@@ -4,6 +4,8 @@
 - [📚API Reference](/documentation/api/lib/doctrine-dbal-bulk)
 - [📁Files](/documentation/api/lib/doctrine-dbal-bulk/indices/files.html)
 
+[TOC]
+
 Flow PHP's Doctrine DBAL Bulk is a specialized library crafted for optimizing bulk operations in your data workflows.
 This library is a prime choice for handling bulk data tasks with the Doctrine Database Abstraction Layer (DBAL),
 augmenting the performance and efficiency of data insertion and manipulation tasks. The Doctrine DBAL Bulk library
diff --git a/documentation/components/libs/filesystem.md b/documentation/components/libs/filesystem.md
@@ -4,6 +4,8 @@
 - [📚API Reference](/documentation/api/lib/filesystem)
 - [📁Files](/documentation/api/lib/filesystem/indices/files.html)
 
+[TOC]
+
 ## Installation
 
 ```
diff --git a/documentation/components/libs/parquet-viewer.md b/documentation/components/libs/parquet-viewer.md
@@ -4,6 +4,8 @@
 - [📚API Reference](/documentation/api/lib/parquet-viewer)
 - [📁Files](/documentation/api/lib/parquet-viewer/indices/files.html)
 
+[TOC]
+
 ## Installation
 
 ```
diff --git a/documentation/components/libs/parquet.md b/documentation/components/libs/parquet.md
diff --git a/documentation/components/libs/pg-query.md b/documentation/components/libs/pg-query.md
diff --git a/documentation/components/libs/snappy.md b/documentation/components/libs/snappy.md
diff --git a/documentation/components/libs/types.md b/documentation/components/libs/types.md
diff --git a/documentation/components/libs/types/architecture.md b/documentation/components/libs/types/architecture.md
diff --git a/documentation/contributing.md b/documentation/contributing.md
diff --git a/documentation/contributing/guidelines.md b/documentation/contributing/guidelines.md
diff --git a/documentation/contributing/nix.md b/documentation/contributing/nix.md
diff --git a/documentation/contributing/wasm.md b/documentation/contributing/wasm.md
diff --git a/documentation/examples.md b/documentation/examples.md
diff --git a/documentation/installation.md b/documentation/installation.md
diff --git a/documentation/quick-start.md b/documentation/quick-start.md
diff --git a/documentation/style-guide.md b/documentation/style-guide.md
diff --git a/documentation/upgrading.md b/documentation/upgrading.md
diff --git a/web/landing/assets/styles/app.css b/web/landing/assets/styles/app.css
diff --git a/web/landing/src/Flow/Website/Service/Markdown/LeagueCommonMarkConverterFactory.php b/web/landing/src/Flow/Website/Service/Markdown/LeagueCommonMarkConverterFactory.php
