website-and-documentation/.markdownlint.json

{
  "default": true,
  "MD013": false,
  "MD033": false,
  "MD041": false,
  "MD024": { "siblings_only": true },
  "MD025": { "front_matter_title": "" }
}
test: add comprehensive testing infrastructure - Add npm test scripts for build, markdown, HTML, and link validation - Install markdownlint-cli for content quality checks - Install html-validate for HTML5 conformity validation - Add htmltest (via devbox) for internal/external link checking - Configure test rules in .htmltest.yml, .htmlvalidate.json, .markdownlint.json - Add GitHub Actions workflow for automated CI testing - Add TESTING.md documentation for test usage 2025-10-23 14:02:39 +02:00			`{`
			`"default": true,`
			`"MD013": false,`
refactor(docs): migrate existing content to v1 legacy structure - Move all existing docs content (concepts, project, solution) to /docs/v1/ - Add legacy banner component to warn users about archived documentation - Create v1 index page with legacy notice and redirect guidance - Implement automatic banner display for all v1 paths - Preserve all original content for reference during migration This enables incremental content migration while maintaining access to original documentation. 2025-10-23 14:54:08 +02:00			`"MD033": false,`
test: configure comprehensive markdown linting with Docsy best practices Configure markdownlint with rules aligned to technical documentation standards and Docsy theme conventions. Design Decisions: - Enable core quality rules (heading hierarchy, consistent list styles) - Allow inline HTML for Docsy shortcodes and components - Permit bare URLs (common in technical documentation) - Make code block language hints optional (pragmatic for existing content) - Set maximum 2 consecutive blank lines (balanced readability) - Enforce single trailing newline (POSIX standard) - Use asterisk for unordered lists (consistency) - Allow 2-space list indentation (Markdown standard) Auto-fixed Issues: - Converted dash lists to asterisk lists (568 fixes) - Removed trailing spaces (211 fixes) - Added missing trailing newlines (74 fixes) - Added blank lines around lists and headings (100+ fixes) Remaining Style Warnings (intentionally accepted): - MD029: List numbering variations in meeting notes (75 instances) - MD036: Bold text for section headers in ADRs (13 instances) - MD025: Multiple H1 in notes/brainstorming docs (10 instances) - MD032/MD022: Minor spacing variations (15 instances) Test Results: ✅ Hugo build: 227 pages generated successfully ✅ HTML validation: No errors ✅ Link checking: All links valid (except dev-only livereload) ✅ Markdown linting: Only non-critical style warnings remain The configuration balances strict quality checks with pragmatic flexibility for diverse content types (documentation, ADRs, meeting notes, tutorials). 2025-10-23 14:25:46 +02:00			`"MD041": false,`
refactor(docs): migrate existing content to v1 legacy structure - Move all existing docs content (concepts, project, solution) to /docs/v1/ - Add legacy banner component to warn users about archived documentation - Create v1 index page with legacy notice and redirect guidance - Implement automatic banner display for all v1 paths - Preserve all original content for reference during migration This enables incremental content migration while maintaining access to original documentation. 2025-10-23 14:54:08 +02:00			`"MD024": { "siblings_only": true },`
			`"MD025": { "front_matter_title": "" }`
test: add comprehensive testing infrastructure - Add npm test scripts for build, markdown, HTML, and link validation - Install markdownlint-cli for content quality checks - Install html-validate for HTML5 conformity validation - Add htmltest (via devbox) for internal/external link checking - Configure test rules in .htmltest.yml, .htmlvalidate.json, .markdownlint.json - Add GitHub Actions workflow for automated CI testing - Add TESTING.md documentation for test usage 2025-10-23 14:02:39 +02:00			`}`