fix spelling issues #1423
fix spelling issues #1423
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 introduces several minor documentation updates across multiple markdown files. In the chain operators documentation, a grammatical correction changes "primary" to "primarily" to better describe the role of archive nodes. In a tutorials document, the comment for a mapping in the 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
|
![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 (2)
pages/stack/fault-proofs/explainer.mdx (2)
1-5: Missing Required Frontmatter MetadataThe frontmatter section is missing several required fields for regular pages:
topic,personas,categories, andcontent_type. Please add these to ensure the page meets the documentation standards.For example, you can run:
pnpm metadata-batch-cli:dry "pages/stack/fault-proofs/explainer.mdx"
88-88: Grammatical Correction: Use of "an" before AcronymThe static analysis tool recommends using “an” instead of “a” before “FP chain,” since “F” (pronounced “eff”) begins with a vowel sound. Please update the sentence as follows:
-However, the capital requirements for operating a FP chain in itself are much larger than 14 ETH. +However, the capital requirements for operating an FP chain in itself are much larger than 14 ETH.🧰 Tools
🪛 LanguageTool
[misspelling] ~88-~88: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ... the capital requirements for operating a FP chain in itself are much larger than...(EN_A_VS_AN)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
pages/operators/chain-operators/architecture.mdx(1 hunks)pages/operators/chain-operators/tutorials/adding-derivation-attributes.mdx(1 hunks)pages/operators/node-operators/management/blobs.mdx(1 hunks)pages/operators/node-operators/management/troubleshooting.mdx(1 hunks)pages/stack/fault-proofs/explainer.mdx(1 hunks)pages/stack/fault-proofs/mips.mdx(1 hunks)
✅ Files skipped from review due to trivial changes (5)
- pages/operators/node-operators/management/blobs.mdx
- pages/operators/chain-operators/tutorials/adding-derivation-attributes.mdx
- pages/operators/node-operators/management/troubleshooting.mdx
- pages/operators/chain-operators/architecture.mdx
- pages/stack/fault-proofs/mips.mdx
🧰 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/stack/fault-proofs/explainer.mdx
🪛 LanguageTool
pages/stack/fault-proofs/explainer.mdx
[misspelling] ~88-~88: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ... the capital requirements for operating a FP chain in itself are much larger than...
(EN_A_VS_AN)
⏰ 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
pages/operators/chain-operators/architecture.mdx
primary - primarily
pages/operators/chain-operators/tutorials/adding-derivation-attributes.mdx
blocks - block
pages/operators/node-operators/management/blobs.mdx
fix space
pages/operators/node-operators/management/troubleshooting.mdx
sto
p - stoppages/stack/fault-proofs/explainer.mdx
is much larger - are much larger
pages/stack/fault-proofs/mips.mdx
fix space