Skip to content

dev: Add Markdown lint setup and docs-analysis CI workflow#46

Merged
offich merged 3 commits intodevelopfrom
dev/markdown-lint
May 2, 2026
Merged

dev: Add Markdown lint setup and docs-analysis CI workflow#46
offich merged 3 commits intodevelopfrom
dev/markdown-lint

Conversation

@offich
Copy link
Copy Markdown
Owner

@offich offich commented May 2, 2026

Description

Add Markdown linting to the project using markdownlint-cli2, along with
a CI workflow (docs-analysis.yml) that runs the lint on push.

What was done

  • Installed markdownlint-cli2 and configured pnpm as the package manager
  • Added .markdownlint-cli2.yaml to disable line-length check in code blocks
  • Fixed existing Markdown lint errors in CHANGELOG.md and
    docs/dev/review-guideline.md
  • Added .github/workflows/docs-analysis.yml with:
    • Triggered on changes to .md files, package.json, pnpm-lock.yaml,
      and the workflow file itself
    • Uses jdx/mise-action (v4.0.1) for Node setup
    • Uses pnpm/action-setup (v5.0.0) to install pnpm
    • Caches pnpm store with actions/cache (v5.0.5)
    • Runs pnpm run lint:markdown
  • Updated .gitignore to exclude node_modules

What was NOT done

  • Lint rules other than line-length are left at default
  • No auto-fix step in CI

Operation Confirmation

Steps

pnpm install
pnpm run lint:markdown

Related URLs

@offich offich merged commit 18e40dd into develop May 2, 2026
1 check passed
@offich offich deleted the dev/markdown-lint branch May 2, 2026 02:10
@offich offich self-assigned this May 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant