Add markdownlint configuration and README adjustments

[AlphaOne1]

Summary by CodeRabbit

• Documentation
  • Updated external link badges in the README for improved security and accuracy.
  • Added a new badge linking to CodeRabbit reviews.
  • Improved formatting and cleaned up minor issues in the README, including Go code examples.
  • Added markdownlint configuration and suppression comments for consistent markdown formatting.

[coderabbitai]

Warning

Rate limit exceeded

@AlphaOne1 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 10 minutes and 51 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between fd52276 and 8ba4e99.

📒 Files selected for processing (2)

• .markdownlint.json (1 hunks)
• README.md (2 hunks)

Walkthrough

A new .markdownlint.json configuration file was introduced to specify markdown linting rules. The README.md was updated to enhance badge link security, update badge URLs, add a CodeRabbit review badge, and improve markdown formatting, including markdownlint suppression comments and minor whitespace cleanup.

Changes

Cohort / File(s)	Change Summary
Markdown Linting Configuration .markdownlint.json	Added configuration file enabling default markdownlint rules, customizing heading style, list indentation, and max line length.
README Badges & Formatting README.md	Updated badge URLs, added noopener noreferrer to external links, added CodeRabbit badge, inserted markdownlint suppression comments, and performed minor formatting and whitespace cleanup.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

A hop and a skip, markdown rules in tow,
Badges shine brighter, as README links now glow.
With linting in place and whitespace set right,
CodeRabbit’s badge joins, hopping with delight!
Security’s tighter, the docs feel brand new—
All in a day’s work, from this rabbit to you. 🐇✨

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch add_coderabbit_badge

---

🪧 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>, please review it.
  • Explain this complex logic.
  • 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 explain this code block.
• 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

[AlphaOne1]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (3)

.markdownlint.json (2)

6-6: Add a newline at EOF

Ensure the file ends with a newline to avoid noisy diffs and align with common tooling expectations.

 }
+ 

---

1-6: Optional: Allow HTML elements via MD033 to avoid local disables

If you prefer not to sprinkle markdownlint-disable comments around the badges, allow specific HTML tags in the config.

 {
     "default": true,
     "MD003": { "style": "setext_with_atx" },
     "MD007": { "indent": 2 },
-    "MD013": { "line_length": 120 }
+    "MD013": { "line_length": 120 },
+    "MD033": { "allowed_elements": ["a", "img", "p", "br"] }
 }

README.md (1)

1-1: markdownlint directives are appropriate for the badge block

Temporarily disabling MD013/MD033/MD041 around the HTML-heavy badge section is a clean approach. If this pattern recurs, consider allowing specific HTML elements via MD033 in the config to avoid local disables.

Also applies to: 71-71

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between aba228b and fd52276.

📒 Files selected for processing (2)

• .markdownlint.json (1 hunks)
• README.md (2 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.17.2)

README.md

189-189: Hard tabs
Column: 1

(MD010, no-hard-tabs)

🔇 Additional comments (2)

.markdownlint.json (1)

1-6: Solid baseline configuration

Defaults enabled with targeted overrides for MD003, MD007, MD013 looks good and aligns with the README usage.

README.md (1)

4-39: Badges: security and link updates look good

Adding rel="noopener noreferrer" for target="_blank" links and updating badge URLs (Codecov, GoDoc→pkg.go.dev) are correct. New CodeRabbit badge is fine.

Also applies to: 41-69