Skip to content

Conversation

crStiv
Copy link

@crStiv crStiv commented Jul 27, 2025

was checking out the contract deployment section in repo and found out the broken link, idk if it's the right one I fixed, but just wanna let you know there's a broken link in common/bytecode/README.md

Summary by CodeRabbit

  • Documentation
    • Updated the README to reference the new URL for pre-deploying contracts.

@coderabbitai
Copy link

coderabbitai bot commented Jul 27, 2025

Walkthrough

The README file in the common/bytecode directory was updated to replace the reference URL for pre-deploying contracts with a new GitHub repository link. No other documentation content or instructions were changed.

Changes

File(s) Change Summary
common/bytecode/README.md Updated contract pre-deploy reference URL

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A README link, now shiny and new,
Guides you to demos, not genesis blue.
With bytes and with code,
Down the rabbit road,
Documentation hops—just for you! 🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.


📜 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 392ae07 and 30c0473.

📒 Files selected for processing (1)
  • common/bytecode/README.md (1 hunks)
🧰 Additional context used
🧠 Learnings (1)
common/bytecode/README.md (1)

Learnt from: colinlyguo
PR: #1530
File: tests/integration-test/go.mod:21-21
Timestamp: 2024-10-20T15:30:18.084Z
Learning: In the tests/integration-test folder, updates to import statements or dependencies are not necessary since it's only used for testing purposes.

🪛 markdownlint-cli2 (0.17.2)
common/bytecode/README.md

2-2: Bare URL used

(MD034, no-bare-urls)

🔇 Additional comments (1)
common/bytecode/README.md (1)

2-2: Update repository references and link formatting in README

Please ensure the link and clone commands in common/bytecode/README.md are consistent and use proper Markdown link syntax:

  • Wrap the URL in a Markdown link instead of a bare URL or autolink.
  • If you intend to replace genesis-creator with scroll-contract-deploy-demo, update all clone/cd/make commands accordingly.
  • Otherwise, revert the link back to the original genesis-creator repo.

Affected locations:

  • Line 2: link text
  • Lines 5–6, 8, 15, 32: git clone, cd, make genesis-creator, and ./bin/genesis-creator commands

Suggested diff for the link only:

-* Please reference to https://github.com/scroll-tech/scroll-contract-deploy-demo.
+* Please reference [scroll-contract-deploy-demo](https://github.com/scroll-tech/scroll-contract-deploy-demo).

Then update or revert the subsequent commands to match the chosen repository.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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

Support

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

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

@Thegaram
Copy link
Contributor

Thank you for reporting the broken link.

@Thegaram Thegaram closed this Jul 27, 2025
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