Merge pull request #144 from code0-tech/73-implement-markdown-linter

Taucher2003 · web-flow · commit c788ce9a58c6 · 2026-04-17T23:52:54.000+02:00
Implement markdown linter
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -31,12 +31,20 @@ build:
 
 lint-links:
   stage: lint
-  image: ghcr.io/code0-tech/build-images/telescopium-lint:271.1
+  image: ghcr.io/code0-tech/build-images/telescopium-lint:291.1
   needs: []
   script:
     - ./clone_projects.sh
     - lychee --offline --no-progress --include-fragments --no-ignore content
 
+lint-markdown:
+  stage: lint
+  image: ghcr.io/code0-tech/build-images/telescopium-lint:291.1
+  needs: []
+  script:
+    - ./clone_projects.sh
+    - rumdl check --fail-on any
+
 pages:
   extends:
     - .build
diff --git a/content/general/changelog.md b/content/general/changelog.md
@@ -3,6 +3,8 @@ title: Changelog
 icon: IconRestore
 ---
 
+<!-- rumdl-configure-file { "MD013": { "headings": false } } -->
+
 All notable changes to the CodeZero software will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
@@ -26,7 +28,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
-- Switched to TypeScript for RuntimeFunction, Function, Flow and DataType definitions. This generelly improves type safety and increased reliability of suggestion and validation.
+- Switched to TypeScript for RuntimeFunction, Function, Flow and DataType definitions.
+  This generelly improves type safety and increased reliability of suggestion and validation.
 - Runtime status is now more accurate and has more details and also exposes features installed on the runtime.
 - Moving dashboard components from UI library named pictor to frontend application named sculptor.
 - New DataTypeType input based on custom type language.
@@ -78,4 +81,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Use variables and nested nodes in flows
 - Support for REST flows
 - Login, register and logout
-- Forgot password, reset password and email verification
+- Forgot password, reset password and email verification
diff --git a/content/general/install.mdx b/content/general/install.mdx
@@ -3,8 +3,6 @@ title: Installation
 icon: IconDownload
 ---
 
-
-
 import {Step, Steps} from 'fumadocs-ui/components/steps';
 
 This guide will walk you through the deployment of CodeZero using Docker. Currently, CodeZero is in active development,
@@ -20,148 +18,150 @@ Before beginning, ensure you have the following installed on your system:
 
 <Steps>
 
-    <Step>
+<Step>
+
+## Clone the latest release
+
+To ensure stability, we recommend using the latest release. Run the following command to clone the
+repository:
 
-        ## Clone the latest release
+Get the newest release version from the [CodeZero GitHub releases page](https://github.com/code0-tech/codezero/releases)
 
-        To ensure stability, we recommend using the latest release. Run the following command to clone the
-        repository:
+```bash
+git clone --branch <version> https://github.com/code0-tech/codezero.git
+```
 
-        Get the newest release version from the [CodeZero GitHub releases page](https://github.com/code0-tech/codezero/releases)
+Navigate to the deployment directory:
 
-        ```bash
-        git clone --branch <version> https://github.com/code0-tech/codezero.git
-        ```
+```bash
+cd codezero/docker-compose/
+```
 
-        Navigate to the deployment directory:
+</Step>
+<Step>
 
-        ```bash
-        cd codezero/docker-compose/
-        ```
+## Configure environment variables
 
-    </Step>
-    <Step>
-        ## Configure environment variables
+CodeZero uses an `.env` file to manage initial credentials and system settings. Create or edit the file:
 
-        CodeZero uses an `.env` file to manage initial credentials and system settings. Create or edit the file:
+```bash
+nano .env
+```
 
-        ```bash
-        nano .env
-        ```
+### The .env template
 
-        ### The .env template
+Ensure your `.env` file contains the following variables. Pay close attention to the Root Credentials and the
+Image
+Edition.
 
-        Ensure your `.env` file contains the following variables. Pay close attention to the Root Credentials and the
-        Image
-        Edition.
+```bash
+# IDE config
+HOSTNAME=localhost
+HTTP_PORT=80
+HTTPS_PORT=443
+SSL_ENABLED=false
+SSL_CERT_FILE= # must be located in ./certs, defaults to "<hostname>.pem"
+SSL_KEY_FILE= # must be located in ./certs, defaults to "<hostname>.key"
 
-        ```bash
-        # IDE config
-        HOSTNAME=localhost
-        HTTP_PORT=80
-        HTTPS_PORT=443
-        SSL_ENABLED=false
-        SSL_CERT_FILE= # must be located in ./certs, defaults to "<hostname>.pem"
-        SSL_KEY_FILE= # must be located in ./certs, defaults to "<hostname>.key"
+INITIAL_ROOT_PASSWORD=root
+INITIAL_ROOT_MAIL=root@code0.tech
 
-        INITIAL_ROOT_PASSWORD=root
-        INITIAL_ROOT_MAIL=root@code0.tech
+# Runtime config
+AQUILA_SAGITTARIUS_URL=http://nginx:80
+AQUILA_SAGITTARIUS_TOKEN=
+DRACO_REST_PORT=8084
 
-        # Runtime config
-        AQUILA_SAGITTARIUS_URL=http://nginx:80
-        AQUILA_SAGITTARIUS_TOKEN=
-        DRACO_REST_PORT=8084
+# Active services
+COMPOSE_PROFILES=ide,runtime
 
-        # Active services
-        COMPOSE_PROFILES=ide,runtime
+# Image config
+IMAGE_REGISTRY=registry.gitlab.com/code0-tech/packages
+IMAGE_TAG= # version
+IMAGE_EDITION= # ce or ee
 
-        # Image config
-        IMAGE_REGISTRY=registry.gitlab.com/code0-tech/packages
-        IMAGE_TAG= # version
-        IMAGE_EDITION= # ce or ee
+# Internal config options
+SAGITTARIUS_RAILS_HOST=sagittarius-rails-web
+SAGITTARIUS_RAILS_PORT=3000
+SAGITTARIUS_GRPC_HOST=sagittarius-grpc
+SAGITTARIUS_GRPC_PORT=50051
+SAGITTARIUS_LOG_LEVEL=info
+SCULPTOR_HOST=sculptor
+SCULPTOR_PORT=3000
+POSTGRES_HOST=postgres
+POSTGRES_PORT=5432
+POSTGRES_DB=sagittarius_production
+POSTGRES_USER=sagittarius
+POSTGRES_PASSWORD=sagittarius
+```
 
-        # Internal config options
-        SAGITTARIUS_RAILS_HOST=sagittarius-rails-web
-        SAGITTARIUS_RAILS_PORT=3000
-        SAGITTARIUS_GRPC_HOST=sagittarius-grpc
-        SAGITTARIUS_GRPC_PORT=50051
-        SAGITTARIUS_LOG_LEVEL=info
-        SCULPTOR_HOST=sculptor
-        SCULPTOR_PORT=3000
-        POSTGRES_HOST=postgres
-        POSTGRES_PORT=5432
-        POSTGRES_DB=sagittarius_production
-        POSTGRES_USER=sagittarius
-        POSTGRES_PASSWORD=sagittarius
-        ```
+### Key parameters
 
-        ### Key parameters:
+- `INITIAL_ROOT_MAIL`: The email address for the primary administrator.
+- `INITIAL_ROOT_PASSWORD`: The secure password for your first login.
+- `IMAGE_EDITION`: Set this to ce for the Community Edition or ee for the Enterprise Edition. This
+  determines which Docker images will be pulled.
 
-        - `INITIAL_ROOT_MAIL`: The email address for the primary administrator.
-        - `INITIAL_ROOT_PASSWORD`: The secure password for your first login.
-        - `IMAGE_EDITION`: Set this to ce for the Community Edition or ee for the Enterprise Edition. This
-        determines which Docker images will be pulled.
+</Step>
+<Step>
 
-    </Step>
-    <Step>
+## Initial deployment
 
-        ## Initial deployment
+Start the CodeZero containers in detached mode:
 
-        Start the CodeZero containers in detached mode:
+```bash
+docker compose up -d
+```
 
-        ```bash
-        docker compose up -d
-        ```
+Once the containers are running, you can access the CodeZero Dashboard via your browser (typically
+at [http://localhost/](http://localhost/)).
 
-        Once the containers are running, you can access the CodeZero Dashboard via your browser (typically
-        at http://localhost/).
+</Step>
+<Step>
 
-    </Step>
-    <Step>
+## Connecting the runtime
 
-        ## Connecting the runtime
+A "Runtime" is the engine that executes your flows. To activate it, you must generate a unique token within the
+dashboard and link it to your configuration.
 
-        A "Runtime" is the engine that executes your flows. To activate it, you must generate a unique token within the
-        dashboard and link it to your configuration.
+### Login
 
-        ### Login
+Log in to the dashboard using the `INITIAL_ROOT_MAIL` and `INITIAL_ROOT_PASSWORD` you defined in your `.env`
+file.
 
-        Log in to the dashboard using the `INITIAL_ROOT_MAIL` and `INITIAL_ROOT_PASSWORD` you defined in your `.env`
-        file.
+![CodeZero Thumbnail](../../public/CodeZero_Login.png)
 
-        ![CodeZero Thumbnail](../../public/CodeZero_Login.png)
+### Create organization or navigate to personal workspace
 
-        ### Create organization or navigate to personal workspace
+![CodeZero Thumbnail](../../public/CodeZero_Install_Overview.png)
 
-        ![CodeZero Thumbnail](../../public/CodeZero_Install_Overview.png)
+### Navigate to runtimes
 
-        ### Navigate to runtimes
+![CodeZero Thumbnail](../../public/CodeZero_Install_Click-on-Runtime.png)
 
-        ![CodeZero Thumbnail](../../public/CodeZero_Install_Click-on-Runtime.png)
+### Create new runtime
 
-        ### Create new runtime
+![CodeZero Thumbnail](../../public/CodeZero_Install_Create-Runtime.png)
 
-        ![CodeZero Thumbnail](../../public/CodeZero_Install_Create-Runtime.png)
+### Copy the generated token
 
-        ### Copy the generated token
+![CodeZero Thumbnail](../../public/CodeZero_Install_Copy-Token.png)
 
-        ![CodeZero Thumbnail](../../public/CodeZero_Install_Copy-Token.png)
+### Update your `.env` file
 
-        ### Update your `.env` file
+Update your .env file with the copied token at `AQUILA_SAGITTARIUS_TOKEN` and save the file.
 
-        Update your .env file with the copied token at `AQUILA_SAGITTARIUS_TOKEN` and save the file.
+</Step>
+<Step>
 
-    </Step>
-    <Step>
+## Finalize the setup
 
-        ## Finalize the setup
+For the changes to take effect and for the runtime to authenticate correctly, restart the containers:
 
-        For the changes to take effect and for the runtime to authenticate correctly, restart the containers:
+```bash
+docker compose restart
+```
 
-        ```bash
-        docker compose restart
-        ```
-    </Step>
+</Step>
 
 </Steps>
 
diff --git a/content/general/introduction.md b/content/general/introduction.md
@@ -43,4 +43,4 @@ repetitive "heavy lifting."
 We are currently focused on growing a professional community of early adopters and contributors. This is an opportunity
 for businesses to help shape a tool that prioritizes modularity, transparency, and efficiency. By integrating CodeZero
 into your workflow, you are not just adopting a tool; you are joining a movement toward more open, adaptable, and
-powerful business management.
+powerful business management.
diff --git a/content/general/troubleshooting.md b/content/general/troubleshooting.md
@@ -3,4 +3,4 @@ title: Troubleshooting
 icon: IconExclamationCircle
 ---
 
-## Under construction
+## Under construction
diff --git a/content/general/tutorials.md b/content/general/tutorials.md
@@ -3,4 +3,4 @@ title: Tutorials
 icon: IconBook2
 ---
 
-## Under construction
+## Under construction
diff --git a/rumdl.toml b/rumdl.toml
