feat: use markdown-linter in CI and locally

[lotyp]

Summary by CodeRabbit

• Documentation
  • Enhanced readability and consistency in various README.md files by formatting adjustments and removing unnecessary characters.
  • Updated contributing guidelines for better clarity and visual appeal.
  • Added detailed explanations and examples in action-specific documentation to improve user understanding.
• New Features
  • Introduced markdown linting in the integration workflow to ensure markdown files adhere to standards.
• Refactor
  • Updated dependencies in the pre-commit configuration to the latest versions.
  • Enhanced the Makefile to include new targets for markdown linting.
• Chores
  • Removed outdated comments and unused configurations across multiple files.

[coderabbitai]

Walkthrough

The project's recent updates focus primarily on enhancing documentation readability and consistency, integrating markdown linting tools, and updating dependencies. Changes also include minor formatting adjustments across various README files, improving command usage clarity, and refining workflow configurations for better maintenance and code quality checks.

Changes

File Path	Change Summary
.github/CONTRIBUTING.md	Reformatted bullet points, adjusted alignment, and cleaned up command examples.
.github/workflows/integrate.yml, .markdownlint.json, .pre-commit-config.yaml, Makefile	Integrated markdown linting, updated hooks and dependencies, added new linting targets.
README.md, .../install/README.md	Updated emojis, removed unnecessary formatting elements, enhanced command clarity, and improved parameter documentation.

🐇💬
O hark! A change doth sweep across the land,
Where files like leaves in brisk autumn winds stand.
Markdown tamed, and lines so neatly pruned,
Commands like stars in dark skies, finely tuned.
Rejoice in code that's cleaner than before,
A rabbit's work—forever striving for more. 🌟📜

---

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f0830f0 and eb3ca23.

Files selected for processing (1)

• .github/workflows/integrate.yml (2 hunks)

Files skipped from review as they are similar to previous changes (1)

• .github/workflows/integrate.yml

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 2