-
Notifications
You must be signed in to change notification settings - Fork 266
Update get-started.mdx #1343
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
Update get-started.mdx #1343
Conversation
Remove ETH denver callout and add faucet link
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe update modifies the "Get Started" page for application developers. A new resource link, Superchain Faucet (https://console.optimism.io/faucet?utm_source=docs), has been added in the tools and resources section to provide access to testnet ETH for Superchain networks. Additionally, a line promoting the "Join the Super Hackathon at ETH Denver 2024" has been removed from the community section. The modifications do not affect the overall document structure or its underlying logic. Possibly related PRs
Suggested reviewers
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
There was a problem hiding this 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/app-developers/get-started.mdx (1)
37-37
: Correct adjective hyphenation in resource description.The descriptive text currently reads "One stop shop to grab testnet ETH for any Superchain network." Update this to "One-stop shop to grab testnet ETH for any Superchain network." to ensure proper hyphenation as required by the style guidelines.
🧰 Tools
🪛 LanguageTool
[grammar] ~37-~37: The adjective “One-stop” is spelled with a hyphen.
Context: ...mism.io/faucet?utm_source=docs) | One stop shop to grab testnet ETH for any Superc...(ONE_STOP_HYPHEN)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/app-developers/get-started.mdx
(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with ...
**/*.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:
- Use sentence case, capitalizing only the first word.
- 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.
- 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/app-developers/get-started.mdx
🪛 LanguageTool
pages/app-developers/get-started.mdx
[grammar] ~37-~37: The adjective “One-stop” is spelled with a hyphen.
Context: ...mism.io/faucet?utm_source=docs) | One stop shop to grab testnet ETH for any Superc...
(ONE_STOP_HYPHEN)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
- GitHub Check: pr-workflow
🔇 Additional comments (1)
pages/app-developers/get-started.mdx (1)
66-71
: Confirm removal of the outdated event callout.The previously included callout promoting "Join the Super Hackathon at ETH Denver 2024" has been removed. Verify that this removal aligns with the current communication strategy and ensure no residual references to ETH Denver remain elsewhere in the document.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~66-~66: You might be missing the article “the” here.
Context: ...20 on user preferred chains. | ## Join app dev community and build together Join ...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[style] ~70-~70: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...developers/discussions) you need. * [Join Discord community](https://discord.gg/o...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~70-~70: You might be missing the article “the” here.
Context: ...opers/discussions) you need. * Join Discord community...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
Remove ETH denver callout and add faucet link
Description
Tests
Additional context
Metadata