Sentence casing all headers #946
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
bradleycamacho
changed the title
|
Sorry, accidently flipped this to |
WalkthroughThe pull request includes several modifications across multiple documentation files, primarily focusing on changing section headers and titles from title case to sentence case for consistency. The content within the sections remains largely unchanged, with minor textual adjustments made for clarity. The changes affect documents related to bridging basics, custom bridges, messaging, and the standard bridge, ensuring a uniform style throughout the documentation. Changes
Possibly related issues
Possibly related PRs
Suggested labels
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
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (1)
pages/builders/app-developers/bridging/custom-bridge.mdx (1)
Line range hint
21-30: Guidelines section updates are informative and well-structuredThe changes in the "Guidelines" section provide valuable information about custom bridges, their risks, and best practices. The use of "you" is consistent, and the technical terms are appropriately formatted. The grammar and spelling are correct.
Consider adding a link to the Superchain Bridges UI for easier reference:
Bridges that extend this interface will be compatible with the [Superchain Bridges UI](https://app.optimism.io/bridge).This change would improve the user experience by providing direct access to the mentioned UI.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (4)
- pages/builders/app-developers/bridging/basics.mdx (1 hunks)
- pages/builders/app-developers/bridging/custom-bridge.mdx (2 hunks)
- pages/builders/app-developers/bridging/messaging.mdx (7 hunks)
- pages/builders/app-developers/bridging/standard-bridge.mdx (4 hunks)
✅ Files skipped from review due to trivial changes (2)
- pages/builders/app-developers/bridging/basics.mdx
- pages/builders/app-developers/bridging/standard-bridge.mdx
🧰 Additional context used
📓 Path-based instructions (2)
pages/builders/app-developers/bridging/custom-bridge.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 headers, 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).
- Use sentence case for H1, H2, and H3 headers, capitalizing only the first word and any proper nouns.
- For all headers (H1, H2, H3), do not change the capitalization of proper nouns; keep them as they are.
"pages/builders/app-developers/bridging/messaging.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 headers, 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).
- Use sentence case for H1, H2, and H3 headers, capitalizing only the first word and any proper nouns.
- For all headers (H1, H2, H3), do not change the capitalization of proper nouns; keep them as they are.
"
🪛 LanguageTool
pages/builders/app-developers/bridging/messaging.mdx
[typographical] ~131-~131: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...sent from L1 to L2 take approximately 1-3 minutes to get from Ethereum to OP Ma...(HYPHEN_TO_EN)
🔇 Additional comments (2)
pages/builders/app-developers/bridging/custom-bridge.mdx (2)
9-12: Introductory paragraph changes look goodThe rephrasing in the introductory paragraph improves clarity and maintains a consistent tone. The use of "you" is appropriate as it directly addresses the reader, which is suitable for documentation. The grammar and spelling are correct.
38-38: Header change to sentence case is correctThe change from "Next Steps" to "Next steps" correctly applies the guideline for using sentence case in H2 headers. This modification improves consistency throughout the document.
This sentence cases all headers on the docs site to align with our new style guide