Skip to content

Resolve Markdown formatting issues reported by markdownlint #170

@HasithaErandika

Description

@HasithaErandika

Description:
Several documentation issues were detected in the docs-devant repository after running automated checks with markdownlint-cli and markdown-link-check. The problems mainly fall into two categories: Markdown syntax/formatting errors and invalid or broken links.

Markdown Lint Issues

Running npx markdownlint-cli "**/*.md" highlighted multiple formatting inconsistencies across documentation files.

Common recurring issues include:

  • MD013 (Line length): Multiple lines exceed the recommended 80-character limit.

    • Example files: pull_request_template.md, README.md.
  • MD034 (Bare URL): URLs or email addresses are not formatted properly as links or enclosed in angle brackets.

    • Example: certification@wso2.com in pull_request_template.md.
  • MD040 (Missing code language): Some fenced code blocks do not specify a language.

    • Example: README.md (lines around 176 and 191).
  • MD051 (Invalid link fragments): Internal anchor links refer to headings that do not exist.

    • Example: [Signing the CLA](#cla) in README.md.
  • MD022 / MD032 (Missing blank lines): Headings and lists are not properly separated with blank lines, affecting readability and lint compliance.

These issues cause lint failures and reduce documentation consistency.


Suggested Labels:
documentation, bug, markdown, good-first-issue

Suggested Assignees:
documentation-team, maintainers

Affected Product Version:
docs-devant (current repository state)

OS, DB, other environment details and versions:

  • Node.js (tested with latest LTS)
  • markdownlint-cli
  • markdown-link-check
  • Environment: Local development setup

Steps to reproduce:

  1. Clone the repository.

  2. Navigate to the repository root.

  3. Run the markdown lint check:

    npx markdownlint-cli "**/*.md"
  4. Review the reported issues such as:

    • Long lines (MD013)
    • Bare URLs (MD034)
    • Missing language specifiers in code blocks (MD040)
    • Invalid anchor links (MD051)
    • Missing blank lines around headings/lists (MD022/MD032)
  5. Optionally run link validation:

    npx markdown-link-check README.md

Related Issues:

  • Broken documentation links detected via markdown-link-check
  • Additional formatting inconsistencies across documentation files

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions