Markdown Linting Across the Codebase

[rohan-pandeyy]

Description

There are currently multiple markdown linting warnings/errors throughout the repository. This issue tracks:

1. Fixing all existing markdown linting issues across the codebase.
2. Adding an automated markdown lint check to the existing PR Check / Linting (pull_request) GitHub Actions workflow so future issues are caught automatically.

Suggested Approach

1. Fix existing markdown linting issues

A convenient way to identify issues is to install the following VSCode extension:

• markdownlint by David Anson

Once installed, the extension will highlight markdown warnings/errors throughout the repository directly inside the editor.

Contributors using other editors can use any compatible markdownlint integration or CLI tooling.

After identifying warnings, fix all markdown formatting issues across the codebase.

2. Add markdown linting to CI

Integrate the following GitHub Action into the existing PR Check / Linting (pull_request) workflow:

• markdownlint-cli2-action

This ensures markdown linting runs automatically on pull requests and prevents new linting issues from being introduced.

Expected Outcome

• All markdown files pass linting checks.
• Markdown linting is enforced automatically in pull requests.
• Documentation formatting stays consistent going forward.

Acceptance Criteria

• All markdown linting warnings/errors are resolved.
• Markdown linting runs successfully in CI.
• PR Check / Linting (pull_request) workflow includes markdown linting.
• Incoming pull requests fail if they contain markdown linting issues.

[VanshajPoonia]

Hi @rohan-pandeyy
I would be happy to be work on this issue if its aligned to the goals.
Thank you!

[rohan-pandeyy]

Go ahead @VanshajPoonia! 😄