Skip to content

Commit 02391ee

Browse files
committed
chore(docs): disable WIP doc lint rules
Disable rules that produce errors for work-in-progress documentation: - MDBOOK002: Internal links (broken links in WIP docs) - MDBOOK004: Duplicate chapter titles - MDBOOK006: Cross-reference anchors - MDBOOK010: Math blocks (false positives with shell $) - MD052: Reference links (false positives with shell variables)
1 parent a5c2cbe commit 02391ee

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

.mdbook-lint.toml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,12 @@ fail-on-errors = true
88
# Disable rules that are too noisy for this project
99
disabled-rules = [
1010
"MD013", # Line length - too strict for documentation
11+
"MD052", # Reference links - false positives with shell variables
12+
"MDBOOK002", # Internal links - WIP docs have broken links
13+
"MDBOOK004", # Duplicate chapter titles - intentional in some sections
1114
"MDBOOK005", # Orphaned files - we have WIP docs
15+
"MDBOOK006", # Cross-reference anchors - WIP docs
16+
"MDBOOK010", # Math blocks - false positives with $ in shell examples
1217
"MDBOOK023", # Chapter title match - intentionally different
1318
"CONTENT004", # Heading capitalization - we use sentence case
1419
"CONTENT007", # Terminology consistency - too strict

docs/.mdbook-lint.toml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,12 @@ fail-on-errors = true
88
# Disable rules that are too noisy for this project
99
disabled-rules = [
1010
"MD013", # Line length - too strict for documentation
11+
"MD052", # Reference links - false positives with shell variables
12+
"MDBOOK002", # Internal links - WIP docs have broken links
13+
"MDBOOK004", # Duplicate chapter titles - intentional in some sections
1114
"MDBOOK005", # Orphaned files - we have WIP docs
15+
"MDBOOK006", # Cross-reference anchors - WIP docs
16+
"MDBOOK010", # Math blocks - false positives with $ in shell examples
1217
"MDBOOK023", # Chapter title match - intentionally different
1318
"CONTENT004", # Heading capitalization - we use sentence case
1419
"CONTENT007", # Terminology consistency - too strict

0 commit comments

Comments
 (0)