Skip to content

Fix all markdown linting issues in README and CONTRIBUTING#43

Merged
chadmf merged 6 commits into
mainfrom
readmefix
Apr 10, 2026
Merged

Fix all markdown linting issues in README and CONTRIBUTING#43
chadmf merged 6 commits into
mainfrom
readmefix

Conversation

@chadmf

@chadmf chadmf commented Apr 10, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Fix all markdown linting issues identified by markdownlint
  • Add blank lines around lists and headings per markdown best practices
  • Add blank lines before all fenced code blocks (MD031 compliance)
  • Add language tags to fenced code blocks (MD040 compliance)

Changes

README.md:

  • ✅ Add blank lines after "Key Features:" and "Target RTO/RPO:" before lists (MD032)
  • ✅ Add blank lines after all section headings (### Getting Started, ### Deployment, ### Operations, ### Community) (MD022)
  • ✅ Add text language tag to repository structure code block (MD040)

CONTRIBUTING.md:

  • ✅ Add blank line after "Additional Resources:" before list (MD032)
  • ✅ Add blank lines before all fenced code blocks (MD031 - 20+ instances)
  • ✅ Add blank lines after bold headings before code blocks
  • ✅ Add blank lines in numbered list items before code blocks
  • ✅ Add blank lines after section headings in Quick Reference
  • ✅ Add text language tags to commit message examples

Issues Fixed

MD031 (Fenced code blocks should be surrounded by blank lines)

Fixed in 20+ locations including:

  • Code Blocks example section
  • YAML Example section
  • Script testing numbered lists
  • Kubernetes manifest testing
  • Commit message examples
  • Feature development workflow
  • Bug fixes and documentation workflows
  • Quick Reference sections (Pre-Commit Checks, Run Specific Hook, Validate YAML, etc.)

MD032 (Lists should be surrounded by blank lines)

Fixed in README.md and CONTRIBUTING.md

MD022 (Headings should be surrounded by blank lines)

Fixed in README.md section headings

MD040 (Fenced code blocks should have a language specified)

Added language tags to code blocks

Why This Matters

Proper markdown formatting:

  • ✅ Improves readability and consistency
  • ✅ Ensures compatibility with all markdown renderers
  • ✅ Passes markdown linting checks in CI/CD
  • ✅ Follows markdown best practices

Test plan

  • Verify all MD031 markdown linting issues are resolved
  • Verify all MD032 issues are resolved
  • Verify all MD022 issues are resolved
  • Verify all MD040 issues are resolved
  • Confirm rendering looks correct
  • Check no new linting issues introduced

🤖 Generated with Claude Code

chadmf and others added 5 commits April 10, 2026 09:23
Move all report files from docs/ to reports/ directory for better organization:
- aap-architecture-validation-report.md
- documentation-audit-report.md
- dr-architecture-validation-report.md
- dr-replication-validation-report.md

Update all references across documentation:
- CONTRIBUTING.md
- docs/INDEX.md (8 references updated)
- docs/aap-containerized-enterprise-dr-architecture.md
- docs/aap-containerized-growth-dr-architecture.md
- docs/aap-containerized-quickstart.md
- docs/dr-replication-implementation-status.md
- docs/dr-testing-guide.md
- reports/documentation-audit-report.md

All paths updated to maintain proper linking between documents.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Ensure all documentation correctly specifies RHEL 9.4+ for AAP 2.6:
- README.md: Update platform prerequisites from "RHEL 8+" to "RHEL 9.4+"
- scripts-guide.md: Update RHEL scripts requirements to "RHEL 9.4+ with AAP 2.6"
- install-rhel-manual.md: Update PostgreSQL prerequisites to "RHEL 9+" with note about AAP 2.6 requiring 9.4+

AAP 2.6 requires RHEL 9.4+ per Red Hat documentation. This change aligns
all documentation with the correct platform requirements.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
* docs: Relocate reports to reports/ directory and update all references

Move all report files from docs/ to reports/ directory for better organization:
- aap-architecture-validation-report.md
- documentation-audit-report.md
- dr-architecture-validation-report.md
- dr-replication-validation-report.md

Update all references across documentation:
- CONTRIBUTING.md
- docs/INDEX.md (8 references updated)
- docs/aap-containerized-enterprise-dr-architecture.md
- docs/aap-containerized-growth-dr-architecture.md
- docs/aap-containerized-quickstart.md
- docs/dr-replication-implementation-status.md
- docs/dr-testing-guide.md
- reports/documentation-audit-report.md

All paths updated to maintain proper linking between documents.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

* docs: Update RHEL version requirements for AAP 2.6 compatibility

Ensure all documentation correctly specifies RHEL 9.4+ for AAP 2.6:
- README.md: Update platform prerequisites from "RHEL 8+" to "RHEL 9.4+"
- scripts-guide.md: Update RHEL scripts requirements to "RHEL 9.4+ with AAP 2.6"
- install-rhel-manual.md: Update PostgreSQL prerequisites to "RHEL 9+" with note about AAP 2.6 requiring 9.4+

AAP 2.6 requires RHEL 9.4+ per Red Hat documentation. This change aligns
all documentation with the correct platform requirements.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>
Add blank lines before all fenced code blocks to comply with MD031:
- Added blank lines after bold text before code blocks
- Added blank lines after headings before code blocks
- Added blank lines in numbered list items before code blocks
- Added language tags to commit message examples (text)

This ensures proper markdown formatting and passes linting checks.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@chadmf chadmf changed the title Fix markdown linting issues in README and CONTRIBUTING Fix all markdown linting issues in README and CONTRIBUTING Apr 10, 2026
@chadmf chadmf merged commit 9e6fb5d into main Apr 10, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant