use GitHub markdown alerts for warning and note

[Roshanjossey]

Describe the changes you've made

use GitHub markdown alerts for warning and note

Checklist

• I have performed a self-review of my own code.
• I have commented on my code, particularly wherever it was hard to understand.
• I have made corresponding changes to the documentation.
• I have followed the code style of the project
• I have tested my code, and it works without errors

Code of Conduct

• I agree to follow this project's Code of Conduct

Summary by CodeRabbit

• Documentation
  • Enhanced alert formatting for warnings and notes in the documentation to improve clarity and visibility for users.

[coderabbitai]

Walkthrough

The pull request updates the formatting in the README.md file by replacing the bold text warnings and notes with Markdown alert syntax. Specifically, it replaces **Warning!** with > [!Warning] and updates the note line similarly. The content remains unchanged, with only the formatting syntax being modified.

Changes

File	Change Summary
README.md	Updated warning and note formatting to use Markdown alert syntax (> [!Warning] and > [!Note]).

Poem

In a garden of docs, I hop with delight,
Changing warnings and notes to a fresher light.
With Markdown alerts shining, crisp and clear,
My little paws skip over each line without fear.
Celebrate the change as we hop into the night! 🐇✨

---

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>, please review it.
  • 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 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 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.
  • @coderabbitai help me debug CodeRabbit configuration file.

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 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. (Beta)
• @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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

README.md (2)

104-107: Improved Warning Alert Formatting

The new GitHub markdown alert syntax for warnings (> [!Warning]) is correctly implemented and enhances the visibility of the alert. Consider reviewing the text wording for tone and consistency—using sentence case might improve readability.

---

110-111: Refine Note Alert Wording

The note alert is properly updated to use the GitHub markdown alert syntax. For improved clarity and brand consistency, please change "react" to "React" and adjust the phrase "please refer them" to "please refer to them."

Suggested diff:

-> All of these guidelines are for static websites, frameworks like react have their own guide (please refer them)
+> All of these guidelines are for static websites, frameworks like React have their own guide (please refer to them)

🧰 Tools

🪛 LanguageTool

[style] ~110-~110: Using many exclamation marks might seem excessive (in this case: 11 exclamation marks for a text that’s 6639 characters long)
Context: ... Not Be Implemented ## 🚅 Optimize > [!Note] > All of these guidelines are for ...

(EN_EXCESSIVE_EXCLAMATION)

---

[grammar] ~111-~111: The name of this brand needs to be capitalized.
Context: ...re for static websites, frameworks like react have their own guide (please refer them...

(ON_SKYPE)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 451a779 and 9f43d3b.

📒 Files selected for processing (1)

• README.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

README.md

[style] ~110-~110: Using many exclamation marks might seem excessive (in this case: 11 exclamation marks for a text that’s 6639 characters long)
Context: ... Not Be Implemented ## 🚅 Optimize > [!Note] > All of these guidelines are for ...

(EN_EXCESSIVE_EXCLAMATION)

---

[grammar] ~111-~111: The name of this brand needs to be capitalized.
Context: ...re for static websites, frameworks like react have their own guide (please refer them...

(ON_SKYPE)