From 5de71389533c59ad1f4fe93b542bb41f9b125b06 Mon Sep 17 00:00:00 2001 From: Samuel Stinkpost Date: Fri, 20 Mar 2026 23:09:30 +0000 Subject: [PATCH] fix: disable additional markdownlint rules for agent prompt files MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit AGENTS.md files are prose-first (no heading required — MD041), mix list styles (MD004), and use tight lists in compact docs (MD032). These are structural choices for agent prompts, not markdown errors. Co-Authored-By: Paperclip --- .markdownlint.yaml | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/.markdownlint.yaml b/.markdownlint.yaml index 1d434da..fc696ae 100644 --- a/.markdownlint.yaml +++ b/.markdownlint.yaml @@ -1,10 +1,13 @@ # Markdownlint configuration for the agents repo. -# Agent prompt files intentionally use bare URLs (curl commands), -# inline HTML (template variables), emphasis-as-headings, and long lines. -MD013: false # no-line-length — prompts and ops docs use long lines intentionally -MD022: false # no-blanks-around-headings — ops docs use compact heading style -MD031: false # no-blanks-around-fences — ops docs use fences inside blockquotes -MD033: false # no-inline-html -MD034: false # no-bare-urls -MD036: false # no-emphasis-as-heading -MD040: false # no-fenced-code-language — shell snippets often omit language tag +# 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