Fix Grammar, Links & Prepositions#1503
Conversation
✅ Deploy Preview for docs-optimism ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThis pull request implements three minor textual updates in the documentation files. In the Possibly related PRs
Suggested reviewers
Tip ⚡🧪 Multi-step agentic review comment chat (experimental)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 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/tools/build.mdx (1)
22-22: Correct noun plurality in documentation text.
The sentence currently reads:"This section provides information on account abstraction, block explorers, testnet faucets, OP Mainnet NFT tools and oracles. You'll find guides, reference, tool, API to help you understand and work with these topics."
To ensure proper plurality and clarity, consider updating it to:
"This section provides information on account abstraction, block explorers, testnet faucets, OP Mainnet NFT tools, and oracles. You'll find guides, references, tools, and APIs to help you understand and work with these topics."
A diff suggestion:
-You'll find guides, reference, tool, API to help you understand and work with these topics. +You'll find guides, references, tools, and APIs to help you understand and work with these topics.This change directly addresses the static analysis hints regarding noun number mismatches.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~22-~22: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ... tools and oracles. You'll find guides, reference, tool, API to help you understand and w...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~22-~22: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...oracles. You'll find guides, reference, tool, API to help you understand and work wi...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
pages/app-developers/tools/build.mdx(1 hunks)pages/stack/smart-contracts.mdx(1 hunks)pages/stack/transactions.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:
- First, check the frontmatter section at the top of the file:
- For regular pages, ensure ALL these fields are present and not empty:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] personas: [non-empty array] categories: [non-empty array] content_type: [valid type] ---
- For landing pages (index.mdx or files with ), only these fields are required:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] ---
- If any required fields are missing or empty, comment:
'This file appears to be missing required metadata. You can fix this by running:Review the changes, then run without :dry to apply them.'pnpm metadata-batch-cli:dry "path/to/this/file.mdx"- 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/tools/build.mdxpages/stack/transactions.mdxpages/stack/smart-contracts.mdx
🪛 LanguageTool
pages/app-developers/tools/build.mdx
[uncategorized] ~22-~22: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ... tools and oracles. You'll find guides, reference, tool, API to help you understand and w...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~22-~22: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...oracles. You'll find guides, reference, tool, API to help you understand and work wi...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
🔇 Additional comments (2)
pages/stack/transactions.mdx (1)
17-17: Preposition improvement in Card title.
The updated Card title "Transaction finality on OP Stack" now correctly includes the preposition "on" for clarity. This aligns with the documentation style guidelines.pages/stack/smart-contracts.mdx (1)
21-21: Updated link for smart contract release process documentation.
The URL has been updated from the outdated path to:https://github.com/ethereum-optimism/optimism/blob/develop/packages/contracts-bedrock/book/src/policies/versioning.mdThis ensures that users are pointed to the current documentation.
2 participants
Before: "You'll find guide, reference, tool, API..."
After: "You'll find guides, references, tools, and APIs..."
Fix: Changed to plural form for clarity.
Updated: Corrected outdated documentation link for smart contract release process.
Before: "Transaction finality OP Stack"
After: "Transaction finality on OP Stack"
Fix: Added missing preposition for proper phrasing.