Skip to content

docs: Correct thirdweb capitalization and updating links. #1130

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 6 commits into from
Nov 20, 2024
Merged

docs: Correct thirdweb capitalization and updating links. #1130

merged 6 commits into from
Nov 20, 2024

Conversation

Joe-Thirdweb
Copy link
Contributor

Description

The goal of this PR is to update the capitalization of instances of thirdweb along with providing updated links.

Updating to proper capitalization. Updating link.
Updating thirdweb capitals as well as links.
Updating thirdweb capitalization and UTM links.
Updating number of chains supported.
@Joe-Thirdweb Joe-Thirdweb requested review from 0xmariniere and a team as code owners November 20, 2024 05:01
Copy link

netlify bot commented Nov 20, 2024

Deploy Preview for docs-optimism ready!

Name Link
🔨 Latest commit dc11ff9
🔍 Latest deploy log https://app.netlify.com/sites/docs-optimism/deploys/673d8250f6a37800089ed9f1
😎 Deploy Preview https://deploy-preview-1130--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 Nov 20, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request introduces several updates to the documentation files related to account abstraction and associated tools. Key changes include the renaming of "ThirdWeb" to "thirdweb" across multiple documents, ensuring consistent capitalization. URLs for thirdweb have been updated to new links that include tracking parameters, enhancing the ability to monitor user engagement. The "account-abstraction.mdx" file has been reorganized into distinct sections, providing clearer information about account abstraction, bundlers, the Superchain paymaster, and a list of relevant tools. Additionally, the inclusion criteria for developers wishing to feature their products have been specified. In the "faucets.mdx" file, links for the Thirdweb Sepolia Faucet and the Thirdweb OP Sepolia Faucet have been updated to new URLs with tracking parameters. The "nft-tools.mdx" file reflects an increase in the multi-chain support value for thirdweb from "1100+" to "2500+", along with updated URLs. Overall, these changes aim to improve the clarity and accessibility of the documentation.

Possibly related PRs

  • Update account-abstraction.mdx #800: This PR updates the account-abstraction.mdx file, which is directly related to the main PR's changes in the same file, enhancing the documentation for account abstraction.
  • Update account-abstraction.mdx #830: This PR also modifies the account-abstraction.mdx file by adding information about thirdweb, which aligns with the main PR's focus on account abstraction tools.
  • Adding thirdweb faucets #829: This PR adds new entries for "thirdweb Sepolia Faucet" and "thirdweb OP Sepolia Faucet" in the faucets.mdx file, which is relevant as the main PR also discusses updates related to thirdweb.
  • Changing faucet link across docs #806: This PR updates URLs in the faucets.mdx file, which is related to the main PR's focus on refining documentation and links concerning thirdweb tools.
  • SendRawTransactionConditional: remove reference to authentication #1086: This PR modifies account-abstraction.mdx to remove references to authentication in the context of the op-txproxy, which is relevant to the overall discussion of account abstraction tools in the main PR.

Suggested labels

documentation

Suggested reviewers

  • 0xmariniere
  • krofax
  • cpengilly

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

🧹 Outside diff range and nitpick comments (2)
pages/builders/tools/build/account-abstraction.mdx (1)

55-57: Improve grammar and formatting in the thirdweb description

The content requires minor grammatical and formatting improvements while maintaining the correct lowercase spelling of "thirdweb".

Apply these changes:

-*   [thirdweb](https://portal.thirdweb.com/react/v5/account-abstraction/get-started?utm_source=opdocs&utm_medium=docs):
-    offers the complete tool-kit to leverage account abstraction technology to enable seamless user experiences for your users. This includes Account Factory contracts that lets your users spin up Smart Accounts, Bundler for UserOps support, and Paymaster to enable gas sponsorships. 
+*   [thirdweb](https://portal.thirdweb.com/react/v5/account-abstraction/get-started?utm_source=opdocs&utm_medium=docs):
+    offers the complete toolkit to leverage account abstraction technology to enable seamless user experiences for your users. This includes Account Factory contracts that let your users spin up Smart Accounts, Bundler for UserOps support, and Paymaster to enable gas sponsorships.
🧰 Tools
🪛 LanguageTool

[grammar] ~56-~56: Possible subject-verb agreement error detected.
Context: ...includes Account Factory contracts that lets your users spin up Smart Accounts, Bund...

(PLURAL_THAT_AGREEMENT)

pages/builders/tools/build/nft-tools.mdx (1)

37-37: Fix table formatting

The table fence is misaligned, which may cause rendering issues in some Markdown processors.

Apply proper table column alignment by ensuring consistent spacing in the table row:

-| Multi-chain        | 3                                                                          | 5                                                                         | 6                                                             | 11                                    | 2500+ [(all EVM chains)](https://thirdweb.com/dashboard/infrastructure/rpc-edge?utm_source=opdocs&utm_medium=docs) | 9                                                                                                                                                                                 |
+| Multi-chain        | 3                                                                          | 5                                                                         | 6                                                             | 11                                    | 2500+ [(all EVM chains)](https://thirdweb.com/dashboard/infrastructure/rpc-edge?utm_source=opdocs&utm_medium=docs) | 9                                                                                                                                                                                  |
🧰 Tools
🪛 GitHub Check: lint

[warning] 37-37:
Misaligned table fence


[warning] 37-37:
Misaligned table fence

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 104f346 and 957ebf4.

📒 Files selected for processing (3)
  • pages/builders/tools/build/account-abstraction.mdx (1 hunks)
  • pages/builders/tools/build/faucets.mdx (1 hunks)
  • pages/builders/tools/build/nft-tools.mdx (2 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
pages/builders/tools/build/account-abstraction.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.
    "
pages/builders/tools/build/faucets.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.
    "
pages/builders/tools/build/nft-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.
    "
🪛 GitHub Check: lint
pages/builders/tools/build/faucets.mdx

[warning] 42-42:
Misaligned table fence


[warning] 42-42:
Misaligned table fence


[warning] 43-43:
Cell should be padded with 1 space, not 12


[warning] 43-43:
Misaligned table fence


[warning] 43-43:
Misaligned table fence

pages/builders/tools/build/nft-tools.mdx

[warning] 37-37:
Misaligned table fence


[warning] 37-37:
Misaligned table fence

🔇 Additional comments (2)
pages/builders/tools/build/nft-tools.mdx (2)

26-26: LGTM: Correct capitalization and URL update

The changes correctly implement the lowercase "thirdweb" branding and add appropriate tracking parameters to the URL.


37-37: LGTM: Updated statistics and URL

The changes accurately reflect the increased multi-chain support (2500+) and maintain consistent URL tracking parameters.

🧰 Tools
🪛 GitHub Check: lint

[warning] 37-37:
Misaligned table fence


[warning] 37-37:
Misaligned table fence

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

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 957ebf4 and 45dc91b.

📒 Files selected for processing (2)
  • pages/builders/tools/build/faucets.mdx (1 hunks)
  • pages/builders/tools/build/nft-tools.mdx (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • pages/builders/tools/build/faucets.mdx
🧰 Additional context used
📓 Path-based instructions (1)
pages/builders/tools/build/nft-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.
    "
🔇 Additional comments (3)
pages/builders/tools/build/nft-tools.mdx (3)

26-26: LGTM: Correct capitalization and URL format

The capitalization of "thirdweb" matches the official branding, and the URL structure with tracking parameters is consistent with documentation standards.


49-49: LGTM: Consistent URL structure

The Moralis documentation URL update follows the consistent pattern of adding tracking parameters for external links.


37-37: Verify the significant increase in multi-chain support

The multi-chain support number has increased significantly from 1100+ to 2500+. While the link provides context, it would be good to verify this substantial change.

✅ Verification successful

Multi-chain support increase from 1100+ to 2500+ chains is confirmed

The git history shows the previous value was indeed 1100+ EVM chains, and it has been updated to 2500+ chains. The change is properly documented with an updated reference link to thirdweb's infrastructure dashboard.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any previous mentions of multi-chain support numbers
rg -i "multi.?chain.*(\d+)" --type mdx

Length of output: 68


Script:

#!/bin/bash
# Search for any previous mentions of chain numbers in markdown files
rg -i "(\d+)\+.*(?:chain|evm)" --type md
rg -i "chain.*(\d+)\+" --type md

# Also check for any mentions in the git history of the specific file
git log -p -- pages/builders/tools/build/nft-tools.mdx | rg -i "(\d+)\+.*(?:chain|evm)"

Length of output: 2990

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
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: 0

🧹 Outside diff range and nitpick comments (1)
pages/builders/tools/build/nft-tools.mdx (1)

44-44: Fix grammatical number agreement in pricing field

The text "NFT Checkouts free for seller (Unlimited transactions)" has a number agreement issue between the singular "seller" and the plural context.

Apply this change:

-NFT Checkouts free for seller (Unlimited transactions)
+NFT Checkouts free for sellers (Unlimited transactions)
🧰 Tools
🪛 LanguageTool

[uncategorized] ~44-~44: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...paign=optimism). NFT Checkouts free for seller (Unlimited transactions). | | Image Hos...

(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 45dc91b and dc11ff9.

📒 Files selected for processing (1)
  • pages/builders/tools/build/nft-tools.mdx (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
pages/builders/tools/build/nft-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.
    "
🪛 LanguageTool
pages/builders/tools/build/nft-tools.mdx

[uncategorized] ~44-~44: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...paign=optimism). NFT Checkouts free for seller (Unlimited transactions). | | Image Hos...

(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)

🔇 Additional comments (3)
pages/builders/tools/build/nft-tools.mdx (3)

26-26: LGTM: URL update with tracking parameters

The URL update for thirdweb is consistent with the tracking parameter format used across the documentation.


49-49: LGTM: Moralis API URL update

The Moralis API URL update with tracking parameters is consistent with the documentation standards.


37-37: Verify the significant increase in multi-chain support

The multi-chain support number for thirdweb has increased significantly from 1100+ to 2500+. Let's verify this claim.

@krofax krofax merged commit e33d79f into ethereum-optimism:main Nov 20, 2024
6 of 7 checks passed
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.

3 participants