chore: make docs MDX-compatible

[samueldemoura]

Summary

Required since over on our website, Gatsby ingests the .md files here as MDX, and the GFM syntax causes the build to break.

---

This change is 

Summary by CodeRabbit

• Documentation
  • Updated the URL formatting in our documentation, replacing plain text with clickable hyperlinks to improve readability and ease of access.

[coderabbitai]

Walkthrough

This pull request updates the URL formatting in two documentation files. The change converts plain text URLs enclosed in angle brackets to Markdown hyperlink syntax, improving clarity and usability without altering any functionality or public API.

Changes

File(s)	Change Summary
docs/contributor-info/pull-requests.md docs/guides/tutorial.md	Updated URL references by converting plain text angle-bracketed URLs into clickable Markdown hyperlinks.

Possibly related PRs

• Fix broken link in javascript-api.md #1655: Involved modifications to URL formatting in docs to use Markdown hyperlink syntax.
• CH22466[sc-website] - Update Node, YARN, Gatsby, React and other dependencies, Update MDX syntax  #1626: Also modified URL formatting in documentation, aligning closely with the changes in this pull request.

Suggested reviewers

• Judahmeek

Poem

I'm a little rabbit, quick on my feet,
Hopping over docs to make them neat.
URLs now shine with markdown grace,
Making links a happier place.
Enjoy the hop, the click, the code -
A rabbit's trail on the documentation road!

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2e06d81 and c808ffb.

📒 Files selected for processing (2)

• docs/contributor-info/pull-requests.md (1 hunks)
• docs/guides/tutorial.md (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: dummy-app-integration-tests (newest)
• GitHub Check: dummy-app-integration-tests (oldest)

🔇 Additional comments (2)

docs/contributor-info/pull-requests.md (1)

40-41: Improved URL Hyperlink Format for MDX Compatibility

The updated Markdown link format now ensures that the URL is both clickable and MDX-compatible. This change improves readability and user experience in the documentation without impacting functionality.

docs/guides/tutorial.md (1)

22-23: Updated URL Formatting to Markdown Syntax

Converting the references from the previous angle bracket style to the Markdown hyperlink format enhances clarity and MDX compatibility. The changes make the links more user-friendly and should ensure a successful build with Gatsby.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.