fix: disable additional markdownlint rules for agent prompt files
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 <noreply@paperclip.ing>
This commit is contained in:
+12
-9
@@ -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 <repo>
|
||||
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
|
||||
|
||||
Reference in New Issue
Block a user