diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml new file mode 100644 index 0000000..e12970b --- /dev/null +++ b/.github/workflows/ci.yaml @@ -0,0 +1,17 @@ +name: CI + +on: + push: + branches: [main] + pull_request: + branches: [main] + +jobs: + lint: + runs-on: runners-privilegedescalation + steps: + - uses: actions/checkout@v6 + - name: Lint Markdown + uses: DavidAnson/markdownlint-cli2-action@v19 + with: + globs: "**/*.md" diff --git a/.markdownlint.yaml b/.markdownlint.yaml new file mode 100644 index 0000000..fc696ae --- /dev/null +++ b/.markdownlint.yaml @@ -0,0 +1,13 @@ +# Markdownlint configuration for the agents repo. +# Agent prompt files are structured prose, not standard markdown docs. +# Many style rules conflict with how agent prompts are intentionally written. +MD004: false # ul-style — ops docs mix asterisk and dash list styles +MD013: false # line-length — prompts and ops docs use long lines intentionally +MD022: false # blanks-around-headings — ops docs use compact heading style +MD031: false # blanks-around-fences — ops docs use fences inside blockquotes +MD032: false # blanks-around-lists — tight lists used in tables and compact docs +MD033: false # inline-html — agent prompts use template variables like +MD034: false # bare-urls — agent prompts contain raw curl command URLs +MD036: false # emphasis-as-heading — agent prompts use emphasis for structure +MD040: false # fenced-code-language — shell snippets often omit language tag +MD041: false # first-line-heading — AGENTS.md files are prose-first by design