Skip to content

docs: fix broken links to Circle's docs#20

Merged
jtieri merged 1 commit intomainfrom
justin/link-fixes
Apr 3, 2025
Merged

docs: fix broken links to Circle's docs#20
jtieri merged 1 commit intomainfrom
justin/link-fixes

Conversation

@jtieri
Copy link
Copy Markdown
Member

@jtieri jtieri commented Apr 2, 2025

Summary by CodeRabbit

  • Documentation
    • Updated the URL for the Cross-Chain Transfer Protocol reference to direct users to the new resource.
    • Revised the hyperlink in the Noble blockchain description to point to the updated documentation on Circle's repository.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 2, 2025

Walkthrough

This pull request updates two documentation files by modifying outdated URL references. The "Cross-Chain Transfer Protocol" link in one markdown file is updated to use a corrected stablecoins URL, while the hyperlink in the Noble blockchain description now points to a Circle-hosted GitHub document instead of one from Centre’s repository. These adjustments ensure that the documentation links direct to the intended resources without altering any functional behavior.

Changes

File(s) Change Summary
pages/cctp/index.mdx Updated "Cross-Chain Transfer Protocol" URL from https://developers.circle.com/stablecoin/docs/cctp-getting-started to https://developers.circle.com/stablecoins/cctp-getting-started.
pages/index.mdx Updated hyperlink in the Noble blockchain description from a Centre GitHub link to a Circle GitHub link.

Poem

I'm a rabbit with a gleeful heart,
Hopping through docs with every part.
Updated links make my burrow shine bright,
Leaping along data trails in the light.
Cheers to fresh paths that feel just right!


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
🪧 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.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
pages/index.mdx (1)

11-11: Update Hyperlink for Smart Contracting Capabilities
The hyperlink has been updated to reference Circle’s hosted GitHub document. This aligns with the PR objective to fix broken links.
Additionally, consider replacing "with regards to" with "regarding" for improved clarity.

🧰 Tools
🪛 LanguageTool

[misspelling] ~11-~11: Although “with regards to” is sometimes used in casual speech, it is typically considered a nonstandard phrase.
Context: ...sign.md) smart contracting capabilities with regards to asset issuance functionality. This func...

(IN_OR_WITH_REGARDS_TO_OF)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 23f2528 and 367e3b9.

📒 Files selected for processing (2)
  • pages/cctp/index.mdx (1 hunks)
  • pages/index.mdx (1 hunks)
🧰 Additional context used
🪛 LanguageTool
pages/index.mdx

[misspelling] ~11-~11: Although “with regards to” is sometimes used in casual speech, it is typically considered a nonstandard phrase.
Context: ...sign.md) smart contracting capabilities with regards to asset issuance functionality. This func...

(IN_OR_WITH_REGARDS_TO_OF)

🔇 Additional comments (1)
pages/cctp/index.mdx (1)

16-16: Update Cross-Chain Transfer Protocol URL
The URL for the Cross-Chain Transfer Protocol has been updated correctly from the old reference to https://developers.circle.com/stablecoins/cctp-getting-started. This change ensures the documentation now points to the accurate, updated resource.

Copy link
Copy Markdown
Contributor

@boojamya boojamya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!
I think we should also mimic these changes in https://github.com/noble-assets/docs/tree/facelift as those docs are much more up to date and should be deployed soon.

@jtieri jtieri merged commit 3958cf4 into main Apr 3, 2025
1 check passed
@jtieri jtieri deleted the justin/link-fixes branch April 3, 2025 14:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants