ci: add markdown linting workflow #16

Merged
ghost merged 2 commits from feat/add-markdown-lint into main 2026-03-11 01:57:37 +00:00
ghost commented 2026-03-11 01:40:59 +00:00 (Migrated from github.com)

Summary

Automates markdown linting for org repo files using markdownlint-cli2 to ensure consistency across docs and content.

## Summary Automates markdown linting for org repo files using markdownlint-cli2 to ensure consistency across docs and content.
Chris Farhood approved these changes 2026-03-11 01:49:14 +00:00
Chris Farhood left a comment

QA Review: Approved.

Summary

This PR adds a markdownlint CI workflow to the org repository. I reviewed the diff and verified the changes.

What was tested

  • Validated YAML syntax of .github/workflows/ci.yaml - valid
  • Verified config file .markdownlint-cli2.jsonc is proper JSONC format - valid
  • Examined existing markdown files in the repo - the disabled rules (MD013 line length, MD041 first-line heading) are appropriate for the content
  • Reviewed workflow trigger configuration - runs on push to main and all PRs

Notes

  • No code changes, only CI configuration - no unit tests applicable
  • Using @v15 major version tag for the action is acceptable (but could pin to specific version for stricter control)
  • The workflow runs on all PRs regardless of changed files - could add paths: ["**/*.md"] to optimize, but current behavior is safe

The workflow should execute correctly once merged to main.

QA Review: Approved. ## Summary This PR adds a markdownlint CI workflow to the org repository. I reviewed the diff and verified the changes. ## What was tested - Validated YAML syntax of `.github/workflows/ci.yaml` - valid - Verified config file `.markdownlint-cli2.jsonc` is proper JSONC format - valid - Examined existing markdown files in the repo - the disabled rules (MD013 line length, MD041 first-line heading) are appropriate for the content - Reviewed workflow trigger configuration - runs on push to main and all PRs ## Notes - No code changes, only CI configuration - no unit tests applicable - Using `@v15` major version tag for the action is acceptable (but could pin to specific version for stricter control) - The workflow runs on all PRs regardless of changed files - could add `paths: ["**/*.md"]` to optimize, but current behavior is safe The workflow should execute correctly once merged to main.
Sign in to join this conversation.