Skip to content

Add Markdown linting for documentation consistency #51

@halcwb

Description

@halcwb

Issue Description

Consider adding Markdown linting to improve documentation consistency and quality.

Suggestion from @draptick

"There are many Markdown linters available. And yes - this would mean having another config file :-) Thoughts?"

Benefits

  • Consistent Markdown formatting across documentation
  • Catch common Markdown issues early
  • Improve documentation readability
  • Standardize documentation style

Considerations

  • Additional configuration file needed
  • CI/CD integration
  • Developer workflow impact
  • Tool selection (markdownlint, remark-lint, etc.)

Implementation Options

  1. markdownlint-cli2 - Popular and well-maintained
  2. remark-lint - Part of unified ecosystem
  3. markdownlint (Ruby version)

Integration Points

  • Pre-commit hooks
  • GitHub Actions workflow
  • VS Code extension
  • Local development workflow

Tasks

  • Evaluate different Markdown linters
  • Create configuration file
  • Set up CI/CD integration
  • Document linting rules and exceptions
  • Update CONTRIBUTING.md with linting guidelines

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions