Skip to content

Docs

Docs #17699

Workflow file for this run

name: Docs
# Cancel workflow if there is a new change to the branch.
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
on:
push:
branches:
- main
paths:
- '**.md'
- '.github/workflows/docs.yml'
merge_group:
pull_request:
branches:
- main
paths:
- '**.md'
- '.github/workflows/docs.yml'
jobs:
check-docs:
name: Markdown Lint
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v4
- name: Lint Markdown
run: make md-check
- name: Link check
uses: lycheeverse/lychee-action@v2.1.0
with:
args: '*.md .github/*.md .github/**/*.md .config/*.md'
# Fail action on broken links
fail: true