Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

zkSync broken link update #12434

Merged
merged 2 commits into from
Mar 13, 2024
Merged

zkSync broken link update #12434

merged 2 commits into from
Mar 13, 2024

Conversation

isaul-garcia
Copy link
Contributor

@isaul-garcia isaul-garcia commented Mar 13, 2024

Description

Related Issue

Summary by CodeRabbit

  • Documentation
    • Updated the link for ZKSync in the scaling section to enhance resource accessibility.
    • Improved the accessibility of ZKSync documentation by updating the link.

Copy link
Contributor

coderabbitai bot commented Mar 13, 2024

Walkthrough

The update involves a straightforward change in the documentation for zk-rollups, specifically adjusting a reference link for ZKSync. The modification shifts the focus from a more detailed developer-oriented page to the main website, potentially to provide a broader overview or direct to a more updated source of information on ZKSync.

Changes

File Path Change Summary
public/content/developers/docs/scaling/zk-rollups/index.md Updated ZKSync link from https://docs.zksync.io/zkevm/ to https://zksync.io/.

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

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>.
    • Generate unit-tests 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 tests 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@github-actions github-actions bot added the content 🖋️ This involves copy additions or edits label Mar 13, 2024
Copy link

netlify bot commented Mar 13, 2024

Deploy Preview for ethereumorg ready!

Name Link
🔨 Latest commit ce784b1
🔍 Latest deploy log https://app.netlify.com/sites/ethereumorg/deploys/65f1c4a19604cb00083747e9
😎 Deploy Preview https://deploy-preview-12434--ethereumorg.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between d419871 and 1aed01c.
Files selected for processing (1)
  • public/content/developers/docs/scaling/zk-rollups/index.md (1 hunks)
Check Runs (1)
label completed (2)
Additional comments: 1
public/content/developers/docs/scaling/zk-rollups/index.md (1)
  • 243-243: The link for ZKSync has been updated to https://zksync.io/. Please ensure this new link is the most appropriate and comprehensive resource for readers seeking information about ZKSync, especially in the context of Ethereum scaling solutions and ZK-rollups. It's important that the link directs users to relevant and up-to-date information.

Update to documentation URL instead of zkSync homepage
Copy link
Contributor Author

@isaul-garcia isaul-garcia left a comment

Choose a reason for hiding this comment

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

Updated broken link to https://docs.zksync.io/

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 1aed01c and ce784b1.
Files selected for processing (1)
  • public/content/developers/docs/scaling/zk-rollups/index.md (1 hunks)
Check Runs (1)
label completed (2)
Additional comments: 1
public/content/developers/docs/scaling/zk-rollups/index.md (1)
  • 243-243: The link for ZKSync has been updated from https://docs.zksync.io/ to https://zksync.io/. This change is appropriate as it directs users to the main homepage of zkSync, which may offer a broader range of information or become the more appropriate destination for users seeking knowledge about zkSync. Ensure that this new link is the most relevant and up-to-date source for zkSync information.

Copy link
Member

@nhsz nhsz left a comment

Choose a reason for hiding this comment

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

Thanks @isaul-garcia!

@nhsz nhsz merged commit 5cabc48 into ethereum:dev Mar 13, 2024
5 of 6 checks passed
Copy link

gitpoap-bot bot commented Mar 13, 2024

Congrats, your important contribution to this open-source project has earned you a GitPOAP!

Be sure to join the Ethereum.org discord if you are interested in contributing further to the project or have any questions for the team.

GitPOAP: 2024 Ethereum.org Contributor:

GitPOAP: 2024 Ethereum.org Contributor GitPOAP Badge

Head to gitpoap.io & connect your GitHub account to mint!

Learn more about GitPOAPs here.

This was referenced Mar 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content 🖋️ This involves copy additions or edits
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants