ci: add docs-check workflow with Markdown lint and Mermaid diagram parse validation #8

Merged

Gandalf merged 7 commits from develop into main 2026-05-17 19:03:34 +01:00

Conversation 0 Commits 7 Files Changed 4 +129

Gandalf commented 2026-05-17 19:03:17 +01:00

Owner

Copy Link

No description provided.

Gandalf added 7 commits 2026-05-17 19:03:19 +01:00

ci: add separate docs-check workflow for Markdown lint and Mermaid parse validation ... a368636ec4

- docs-check.yml runs on push/PR only when .md files change
- markdown-lint job: uses markdownlint-cli to check all .md files
- mermaid-parse job: extracts all mermaid blocks from .md files and
  validates each via mmdc (mermaid-js CLI) in headless Chromium
- Both jobs use continue-on-error: true so docs failures never block
  a release or fail the main CI pipeline
- .markdownlint.json disables MD013 (line length), MD033 (inline HTML),
  MD041 (first-line heading) to reduce noise on this repo

ci: trigger docs-check workflow a42392fec6

ci: disable noisy markdownlint rules (table style, blanks, code lang, etc) 6bf8098265

ci: fix mermaid parse check — use mermaid.core.mjs (no Puppeteer/Chromium needed) 6cf01f5530

ci: trigger docs-check workflow 43cb3a0d17

ci: fix mermaid parse — use jsdom to provide browser globals required by mermaid.core.mjs 42d01da7f7

ci: trigger docs-check workflow fce8a9ece6

Gandalf merged commit b2d941a767 into main 2026-05-17 19:03:34 +01:00

Gandalf referenced this issue from a commit 2026-05-17 19:03:36 +01:00

Merge pull request 'ci: add docs-check workflow with Markdown lint and Mermaid diagram parse validation' (#8) from develop into main

Sign in to join this conversation.

Reviewers

No Reviewers

Labels

Clear labels

Compat/Breaking

Breaking change that won't be backward compatible

Kind/Bug

Something is not working

Kind/Documentation

Documentation changes

Kind/Enhancement

Improve existing functionality

Kind/Feature

New functionality

Kind/Security

This is security issue

Kind/Testing

Issue or pull request related to testing

Priority

Critical

1

The priority is critical

Priority

High

2

The priority is high

Priority

Low

4

The priority is low

Priority

Medium

3

The priority is medium

Reviewed

Confirmed

1

Issue has been confirmed

Reviewed

Duplicate

2

This issue or pull request already exists

Reviewed

Invalid

3

Invalid issue

Reviewed

Won't Fix

3

This issue won't be fixed

Status

Abandoned

3

Somebody has started to work on this but abandoned work

Status

Blocked

1

Something is blocking this issue or pull request

Status

Need More Info

2

Feedback is required to reproduce issue or to continue work

No Label

Milestone

No items

No Milestone

Projects

Clear projects

No project

Assignees

Clear assignees

Gandalf

No Assignees

1 Participants

Notifications

Subscribe

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: Gandalf/sofarr#8