Skip to content

Remove optimism sdk link #1225

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

Merged
merged 2 commits into from
Jan 8, 2025
Merged

Remove optimism sdk link #1225

merged 2 commits into from
Jan 8, 2025

Conversation

krofax
Copy link
Collaborator

@krofax krofax commented Jan 6, 2025

Description

Tests

Additional context

Metadata

@krofax krofax requested a review from a team as a code owner January 6, 2025 18:37
Copy link

netlify bot commented Jan 6, 2025

Deploy Preview for docs-optimism ready!

Name Link
🔨 Latest commit 47dd8c8
🔍 Latest deploy log https://app.netlify.com/sites/docs-optimism/deploys/677c240fd739670008de4b98
😎 Deploy Preview https://deploy-preview-1225--docs-optimism.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 bot commented Jan 6, 2025

Warning

Rate limit exceeded

@krofax has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 26 minutes and 19 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between dcf772d and 47dd8c8.

📒 Files selected for processing (1)
  • pages/builders/tools/op-tools.mdx (1 hunks)
📝 Walkthrough

Walkthrough

The pull request introduces changes to the Optimism tools documentation, specifically in the op-tools.mdx and _meta.json files. The modifications involve updating the resource cards and removing the SDK entry. The changes reflect the ongoing deprecation of the Optimism SDK by adding new cards for various Optimism ecosystem tools such as the OP Mainnet explorer, Superchain bridges, faucet, developer console, and gas tracker. The _meta.json file has been updated to remove the SDK-related entry, aligning with the broader documentation updates related to SDK deprecation.

Assessment against linked issues

Objective Addressed Explanation
Update SDK link
Add Viem reference No explicit Viem link added in this PR
Improve page metadata MDX metadata not updated as suggested in the issue

Possibly related PRs

Suggested reviewers

  • sbvegan

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

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
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: 1

🔭 Outside diff range comments (1)
pages/builders/tools/op-tools.mdx (1)

Line range hint 1-14: Complete the introductory sentence

The sentence "This section provides information on ." is incomplete. Consider completing it with a comprehensive overview of the tools section.

Example completion:

-This section provides information on .
+This section provides information on essential tools and resources in the Optimism ecosystem.
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f5e8bfd and dcf772d.

📒 Files selected for processing (2)
  • pages/builders/tools/op-tools.mdx (1 hunks)
  • pages/builders/tools/op-tools/_meta.json (0 hunks)
💤 Files with no reviewable changes (1)
  • pages/builders/tools/op-tools/_meta.json
🧰 Additional context used
📓 Path-based instructions (1)
pages/builders/tools/op-tools.mdx (1)

Pattern **/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:

  • Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
  • Avoid gender-specific language and use the imperative form.
  • Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
  • Ensure proper nouns are capitalized in sentences.
  • Apply the Oxford comma.
  • Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
  • Use correct spelling and grammar at all times (IMPORTANT).
  • For H1, H2, and H3 headers:
    1. Use sentence case, capitalizing only the first word.
    2. Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
    3. Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
  • Flag any headers that seem to inconsistently apply these rules for manual review.
  • When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
    "
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: pr-workflow
  • GitHub Check: Redirect rules - docs-optimism
  • GitHub Check: Header rules - docs-optimism
  • GitHub Check: Pages changed - docs-optimism
🔇 Additional comments (1)
pages/builders/tools/op-tools.mdx (1)

16-24: Maintain consistency in URL tracking parameters

Some URLs include UTM parameters while others don't. Consider adding UTM parameters consistently across all external links for better analytics tracking.

Let's verify the accessibility of all links:

@cpengilly cpengilly merged commit 46a3b86 into main Jan 8, 2025
5 of 8 checks passed
@cpengilly cpengilly deleted the fix-sdk-link branch January 8, 2025 21:14
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.

[2024 Q4 Audit] builders/tools/overview.mdx
2 participants