Fix a typo and add a sanity check #1374
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe pull request modifies the documentation for the SuperchainERC20 Starter Kit by changing the Git clone command from SSH to HTTPS format. The command is updated from Possibly related PRs
Suggested reviewers
📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
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
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
pages/app-developers/starter-kit.mdx (1)
75-80: Review nested<details>tags in the sanity check section
The new sanity check block appears to have two consecutive<details>tags, which results in unnecessary nesting. To improve clarity and ensure the intended collapsible section works correctly, remove the redundant<details>tag. You can simplify this block so that it only uses a single<details>container.For example, modify the block as follows:
- <details> - <details> - <summary>Sanity check</summary> - blah - </details> - </details> + <details> + <summary>Sanity check</summary> + blah + </details>
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/app-developers/starter-kit.mdx(2 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/starter-kit.mdx
🔇 Additional comments (1)
pages/app-developers/starter-kit.mdx (1)
46-46: Updated clone command: HTTPS Version Used
The clone command now uses the HTTPS URL instead of SSH, which should provide a more reliable cloning experience for users.
Description
The provided git command,
Didn't work for me, so I replaced it with a command that should always work,
I added a sanity check at the end of the setup phase so people can see it works.
Tests
N/A
Additional context
N/A
Metadata
N/A