Fix Breadcrumbs on Desktop and Mobile #1001
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
WalkthroughThe pull request introduces a new script in Changes
Possibly related issues
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: 53
🧹 Outside diff range and nitpick comments (28)
pages/stack/operators.mdx (1)
12-14: Consider adding more cards or simplifying the structure.The Cards component is currently used with only a single Card. If there are more relevant topics for operators, consider adding more cards. If not, you might want to simplify the structure by removing the Cards component and using a direct link instead.
If you decide to keep the current structure, no changes are needed. However, if you want to simplify it, you could use:
For more information, see [Features](/stack/operators/features).Alternatively, if you plan to add more cards in the future, you can leave a comment indicating this intention:
<Cards> <Card title="Features" href="/stack/operators/features" /> {/* TODO: Add more cards for operator-related topics */} </Cards>pages/connect/resources.mdx (2)
12-14: LGTM: Cards component is correctly implemented.The Cards component is properly used with a Card for the Glossary. Consider adding more resource cards if there are additional topics or sections available for users.
1-14: Consider these final improvements:
- Add a newline at the end of the file to follow best practices for text files.
- Expand the content to provide more value to users. For example:
- Add a brief introduction explaining the purpose of the Resources section.
- Include more Card components for other relevant resources or topics.
- Ensure consistency with other documentation pages in terms of structure and content depth.
These improvements will enhance the overall quality and usefulness of the Resources page.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~10-~10: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...n provides information on . You'll find concept to help you understand and work with th...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
pages/stack/security.mdx (2)
8-10: Improve description and capitalization.The header and brief description provide a good introduction, but there are a few areas for improvement:
- Capitalize "OP Stack" as it's a proper noun.
- Use all caps for "FAQs" as it's an acronym.
- Consider expanding the description to provide more context about the security aspects covered.
Here's a suggested revision:
# Security This section provides information on OP Stack security FAQs and instructions for pausing the bridge in case of emergencies. Learn about our security measures and how to respond to potential issues.
12-15: Adjust capitalization in Card titles.The Card components are structured correctly, but the titles need capitalization adjustments to follow the title case guideline for proper nouns and acronyms. Here's the suggested revision:
<Cards> <Card title="OP Stack Security FAQs" href="/stack/security/faq" /> <Card title="Pausing the Bridge" href="/stack/security/pause" /> </Cards>This ensures consistent capitalization of "OP Stack" as a proper noun, "FAQs" as an acronym, and applies title case to "Pausing the Bridge".
pages/builders/tools/connect.mdx (1)
10-10: Enhance the description for clarity.The current description is brief but could be more informative. Consider expanding it to provide more context about the importance of networks and RPC & node providers in the OP Stack ecosystem.
Suggestion:
This section provides essential information on networks and RPC & node providers within the OP Stack ecosystem. You'll find references to help you understand these crucial components and effectively work with them in your projects.pages/builders/app-developers/tools.mdx (1)
15-15: Add a newline character at the end of the file.To adhere to common coding standards, please add a newline character at the end of the file.
Add an empty line after the closing
</Cards>tag.pages/builders/cex-wallet-developers.mdx (1)
1-4: Correct capitalization in the titleThe title should use proper capitalization for the acronym "CEX".
Apply this change to the title in the frontmatter:
--- -title: Cex Wallet Developers +title: CEX Wallet Developers lang: en-US ---pages/builders/app-developers/contracts.mdx (3)
1-4: Add a description property to the frontmatter.To improve SEO and provide a quick summary of the page content, consider adding a
descriptionproperty to the frontmatter. This will also address the static analysis warning.Here's a suggested addition:
--- title: Contracts lang: en-US +description: Overview of Solidity compatibility, contract optimization, and system contracts on OP Mainnet for app developers. ---🧰 Tools
🪛 GitHub Check: lint
[warning] 1-1:
Missing newline character at end of file
[warning] 1-1:
Must have required property 'description' • /home/runner/work/docs/docs/utils/schemas/page.schema.yaml • #/required
12-16: LGTM: Card components are well-structured.The
CardsandCardcomponents are used correctly to present the main topics. The titles follow the title case guideline, which is good. For consistency with the previous suggestion:Consider updating "op mainnet" to "OP Mainnet" in the card titles:
<Cards> <Card title="Solidity compatibility" href="/builders/app-developers/contracts/compatibility" /> - <Card title="Contract optimization on op mainnet" href="/builders/app-developers/contracts/optimization" /> - <Card title="Using op mainnet system contracts" href="/builders/app-developers/contracts/system-contracts" /> + <Card title="Contract optimization on OP Mainnet" href="/builders/app-developers/contracts/optimization" /> + <Card title="Using OP Mainnet system contracts" href="/builders/app-developers/contracts/system-contracts" /> </Cards>
16-16: Add a newline character at the end of the file.To adhere to common best practices and potentially prevent issues with certain tools, add a newline character at the end of the file.
Simply add an empty line after the last
</Cards>closing tag.pages/stack/protocol.mdx (2)
8-10: Minor grammatical improvement needed in the overview.The overview paragraph provides a clear description of the section's content. However, there's a small grammatical issue that can be improved:
Consider revising line 10 as follows:
- This section provides information on derivation pipeline, fault proofs, features, interop, sequencer outages and rollup. You'll find overview, reference, guide to help you understand and work with these topics. + This section provides information on derivation pipeline, fault proofs, features, interop, sequencer outages and rollup. You'll find an overview, reference, and guide to help you understand and work with these topics.This change adds the missing article "an" and improves the list structure with the Oxford comma.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~10-~10: You might be missing the article “an” here.
Context: ...quencer outages and rollup. You'll find overview, reference, guide to help you understan...(AI_EN_LECTOR_MISSING_DETERMINER_AN)
12-19: LGTM: Well-structured Card components with a minor suggestion.The use of Card components provides a clean and organized layout for the subtopics. The titles and links are appropriately formatted.
For consistency, consider updating the "Interop" card title to its full form:
- <Card title="Interop" href="/stack/protocol/interop" /> + <Card title="Interoperability" href="/stack/protocol/interop" />This change aligns the card title with the full term used in the overview paragraph.
pages/builders/chain-operators/tools.mdx (1)
12-18: LGTM: Card components are well-structured and follow guidelines.The Card components are appropriately used for navigation, with descriptive titles in correct title case. The href attributes seem to point to relevant pages within the documentation.
For consistency, consider updating the title of the third Card:
- <Card title="How to configure challenger for your chain" href="/builders/chain-operators/tools/op-challenger" /> + <Card title="Configuring Challenger for Your Chain" href="/builders/chain-operators/tools/op-challenger" />This change makes the title consistent with the style of the other Card titles, which are noun phrases rather than questions.
pages/builders.mdx (1)
1-5: Improve the description for clarity and conciseness.The description provides good information but can be enhanced. Consider the following revision:
- description: Learn about deploying contracts, cross-chain messaging, and tutorials to help you build applications on OP Mainnet. + description: Explore guides for deploying contracts, implementing cross-chain messaging, and building applications on OP Mainnet.This revision:
- Removes redundancy ("Learn about" and "tutorials to help you").
- Uses more active language ("Explore guides").
- Maintains the key points while being more concise.
pages/builders/node-operators/management.mdx (1)
10-10: Improve grammar and clarity in the introductory paragraph.Consider revising the paragraph for better grammar and clarity:
- This section provides information on using blobs, node metrics and monitoring, using snap sync for node operators, node snapshots and node troubleshooting. You'll find api, reference, guide to help you understand and work with these topics. + This section provides information on using blobs, node metrics and monitoring, using snap sync for node operators, node snapshots, and node troubleshooting. You'll find APIs, references, and guides to help you understand and work with these topics.This revision:
- Adds the Oxford comma before "and node troubleshooting".
- Capitalizes "API" and pluralizes "references" and "guides".
- Improves overall sentence structure and clarity.
pages/builders/app-developers.mdx (3)
8-12: Improve formatting of the welcome messageThe welcome message is informative, but its formatting could be improved for better readability.
Consider applying these changes:
- Split the welcome message into two paragraphs for better readability.
- Use sentence case for the heading, as per the coding guidelines.
Here's a suggested revision:
-# App Developers +# App developers -Welcome to the App Developers section, where you'll find essential resources for deploying contracts, handling transactions, cross-chain messaging, and more. -Access quick-start guides, tutorials, and tools to help you build applications on the OP Stack efficiently +Welcome to the App Developers section, where you'll find essential resources for deploying contracts, handling transactions, cross-chain messaging, and more. + +Access quick-start guides, tutorials, and tools to help you build applications on the OP Stack efficiently.
13-21: Adjust Card titles for consistent title caseThe Card titles should use proper title case as per the coding guidelines.
Please apply title case to all Card titles. Here's the suggested revision:
<Cards> - <Card title="Overview" href="/builders/app-developers/overview" /> - <Card title="Superchain App Quick Start" href="/builders/app-developers/quick-start" /> - <Card title="Tutorials" href="/builders/app-developers/tutorials" /> - <Card title="Smart Contracts" href="/builders/app-developers/contracts" /> - <Card title="Transactions" href="/builders/app-developers/transactions" /> - <Card title="Bridging" href="/builders/app-developers/bridging" /> - <Card title="App Tools" href="/builders/app-developers/tools" /> + <Card title="Overview" href="/builders/app-developers/overview" /> + <Card title="Superchain App Quick Start" href="/builders/app-developers/quick-start" /> + <Card title="Tutorials" href="/builders/app-developers/tutorials" /> + <Card title="Smart Contracts" href="/builders/app-developers/contracts" /> + <Card title="Transactions" href="/builders/app-developers/transactions" /> + <Card title="Bridging" href="/builders/app-developers/bridging" /> + <Card title="App Tools" href="/builders/app-developers/tools" /> </Cards>
21-21: Add a newline character at the end of the fileTo adhere to best practices and prevent potential issues with certain tools, please add a newline character at the end of the file.
Simply add an empty line after the closing
</Cards>tag.pages/builders/app-developers/transactions.mdx (1)
18-18: Add a newline character at the end of the file.To comply with common coding standards and resolve the linter warning, add a newline character at the end of the file.
Add a newline after the closing
</Cards>tag.pages/stack/protocol/fault-proofs.mdx (2)
10-10: Improve clarity and consistency in the introductory paragraph.Consider revising the introductory paragraph for better clarity, consistency, and adherence to technical writing standards. Here's a suggested revision:
This section provides information on various aspects of fault proofs, including the fault proof VM (Cannon), OP Challenger, system components, mainnet security, and the MIPS.sol fault proof VM. You will find references, guides, overviews, APIs, and introductions to help you understand and work with these topics.This revision addresses the following:
- Consistent capitalization of "fault proof" and related terms.
- Removal of informal language ("You'll").
- Improved sentence structure for better readability.
- Use of Oxford comma for clarity.
12-19: LGTM with minor suggestion: Consistent capitalization in Card titles.The Cards component is well-structured with appropriate titles and href attributes. However, there's a minor inconsistency in the capitalization of "vm" in two of the Card titles. Consider the following changes for consistency:
- <Card title="Fault proof vm: cannon" href="/stack/protocol/fault-proofs/cannon" /> + <Card title="Fault Proof VM: Cannon" href="/stack/protocol/fault-proofs/cannon" /> ... - <Card title="Fault proof vm: mips.sol" href="/stack/protocol/fault-proofs/mips" /> + <Card title="Fault Proof VM: MIPS.sol" href="/stack/protocol/fault-proofs/mips" />This change ensures consistent capitalization and proper noun usage across all Card titles.
pages/builders/chain-operators/management.mdx (1)
12-19: LGTM: Cards component is well-structured.The Cards component is correctly implemented with proper title case for each Card title. The href attributes are correctly formatted as relative paths.
For consistency with the introduction paragraph, consider changing "Troubleshooting: chain operations" to "Troubleshooting chain operations" in the last Card title:
- <Card title="Troubleshooting: chain operations" href="/builders/chain-operators/management/troubleshooting" /> + <Card title="Troubleshooting chain operations" href="/builders/chain-operators/management/troubleshooting" />This change aligns with the revised introduction and maintains consistency across the document.
pages/builders/chain-operators.mdx (2)
1-4: Use sentence case for the title in the frontmatterAccording to our coding guidelines, we should use sentence case for headers. Please update the title in the frontmatter to follow this convention.
Apply this change:
--- -title: Chain Operators +title: Chain operators lang: en-US ---
12-22: Use sentence case for Card titlesAccording to our coding guidelines, we should use sentence case for headers and links while preserving proper noun capitalization. Please update the Card titles to follow this convention.
Apply these changes to the Card titles:
<Cards> - <Card title="Chain architecture" href="/builders/chain-operators/architecture" /> - <Card title="Configuration" href="/builders/chain-operators/configuration" /> - <Card title="Deploy" href="/builders/chain-operators/deploy" /> - <Card title="Features" href="/builders/chain-operators/features" /> - <Card title="Hacks" href="/builders/chain-operators/hacks" /> - <Card title="Management" href="/builders/chain-operators/management" /> - <Card title="How to start a self Hosted chain" href="/builders/chain-operators/self-hosted" /> - <Card title="Tools" href="/builders/chain-operators/tools" /> - <Card title="Tutorials" href="/builders/chain-operators/tutorials" /> + <Card title="Chain architecture" href="/builders/chain-operators/architecture" /> + <Card title="Configuration" href="/builders/chain-operators/configuration" /> + <Card title="Deploy" href="/builders/chain-operators/deploy" /> + <Card title="Features" href="/builders/chain-operators/features" /> + <Card title="Hacks" href="/builders/chain-operators/hacks" /> + <Card title="Management" href="/builders/chain-operators/management" /> + <Card title="How to start a self-hosted chain" href="/builders/chain-operators/self-hosted" /> + <Card title="Tools" href="/builders/chain-operators/tools" /> + <Card title="Tutorials" href="/builders/chain-operators/tutorials" /> </Cards>Note that "Chain architecture" remains capitalized as it contains a proper noun.
package.json (1)
11-11: LGTM! Consider adding this script to the build process.The new
create-breadcrumbsscript aligns well with the PR objectives of enhancing breadcrumb navigation. It's a good addition that will help automate the process of creating and updating .mdx files.To ensure the breadcrumbs are always up-to-date, consider incorporating this script into your build process. You could add it to the
buildscript like this:- "build": "next build", + "build": "npm run create-breadcrumbs && next build",This way, the breadcrumbs will be automatically updated every time you build the project.
pages/builders/app-developers/bridging/custom-bridge.mdx (1)
Line range hint
1-53: Ensure consistent capitalization in headers.The document generally follows the coding guidelines well. However, to fully adhere to the guidelines, please ensure that all headers (H1, H2, H3) use sentence case, capitalizing only the first word and any proper nouns.
For example, update the following headers:
- # Custom Bridges + # Custom bridges - ## Guidelines + ## Guidelines - ## The Superchain Token List + ## The Superchain token list - ## Next Steps + ## Next stepsutils/create-breadcrumbs.ts (1)
27-31: Handle single-topic overviews gracefully ingenerateOverviewWhen there is only one unique topic, the current logic may produce an incomplete or awkward sentence because
uniqueTopics.slice(0, -1)returns an empty array. This affects the readability of the generated overview. Consider adjusting the logic to handle scenarios with a single topic.Here's a suggested modification:
let overview = `This section provides information on `; + if (uniqueTopics.length === 1) { + overview += `${uniqueTopics[0]}. `; + } else { overview += `${uniqueTopics.slice(0, -1).join(', ')}`; if (uniqueTopics.length > 1) { overview += ` and ${uniqueTopics[uniqueTopics.length - 1]}`; } overview += '. '; + }This change ensures that the overview sentence is properly constructed regardless of the number of topics.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (43)
- package.json (1 hunks)
- pages/builders.mdx (1 hunks)
- pages/builders/app-developers.mdx (1 hunks)
- pages/builders/app-developers/bridging.mdx (1 hunks)
- pages/builders/app-developers/bridging/custom-bridge.mdx (2 hunks)
- pages/builders/app-developers/contracts.mdx (1 hunks)
- pages/builders/app-developers/tools.mdx (1 hunks)
- pages/builders/app-developers/transactions.mdx (1 hunks)
- pages/builders/app-developers/tutorials.mdx (1 hunks)
- pages/builders/cex-wallet-developers.mdx (1 hunks)
- pages/builders/chain-operators.mdx (1 hunks)
- pages/builders/chain-operators/configuration.mdx (1 hunks)
- pages/builders/chain-operators/deploy.mdx (1 hunks)
- pages/builders/chain-operators/features.mdx (1 hunks)
- pages/builders/chain-operators/hacks.mdx (1 hunks)
- pages/builders/chain-operators/management.mdx (1 hunks)
- pages/builders/chain-operators/tools.mdx (1 hunks)
- pages/builders/chain-operators/tutorials.mdx (1 hunks)
- pages/builders/node-operators.mdx (1 hunks)
- pages/builders/node-operators/configuration.mdx (1 hunks)
- pages/builders/node-operators/management.mdx (1 hunks)
- pages/builders/node-operators/tutorials.mdx (1 hunks)
- pages/builders/notices.mdx (1 hunks)
- pages/builders/tools.mdx (1 hunks)
- pages/builders/tools/build.mdx (1 hunks)
- pages/builders/tools/connect.mdx (1 hunks)
- pages/builders/tools/monitor.mdx (1 hunks)
- pages/builders/tools/op-tools.mdx (1 hunks)
- pages/chain/identity.mdx (1 hunks)
- pages/chain/security.mdx (1 hunks)
- pages/chain/testing.mdx (1 hunks)
- pages/connect/contribute.mdx (1 hunks)
- pages/connect/resources.mdx (1 hunks)
- pages/stack/operators.mdx (1 hunks)
- pages/stack/operators/features.mdx (1 hunks)
- pages/stack/protocol.mdx (1 hunks)
- pages/stack/protocol/fault-proofs.mdx (1 hunks)
- pages/stack/protocol/features.mdx (1 hunks)
- pages/stack/protocol/interop.mdx (1 hunks)
- pages/stack/protocol/rollup.mdx (1 hunks)
- pages/stack/security.mdx (1 hunks)
- pages/stack/transactions.mdx (1 hunks)
- utils/create-breadcrumbs.ts (1 hunks)
✅ Files skipped from review due to trivial changes (1)
- pages/builders/tools/op-tools.mdx
🧰 Additional context used
📓 Path-based instructions (40)
pages/builders.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.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.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/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/contracts.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/tools.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/transactions.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/tutorials.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/cex-wallet-developers.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/chain-operators.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/chain-operators/configuration.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/chain-operators/deploy.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/chain-operators/features.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/chain-operators/hacks.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/chain-operators/management.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/chain-operators/tools.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/chain-operators/tutorials.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/node-operators.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/node-operators/configuration.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/node-operators/management.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/node-operators/tutorials.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/notices.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/tools.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/tools/build.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/tools/connect.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/tools/monitor.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/chain/identity.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/chain/security.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/chain/testing.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/connect/contribute.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/connect/resources.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/stack/operators.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/stack/operators/features.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/stack/protocol.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/stack/protocol/fault-proofs.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/stack/protocol/features.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/stack/protocol/interop.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/stack/protocol/rollup.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/stack/security.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/stack/transactions.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.
"
🪛 GitHub Check: lint
pages/builders/app-developers.mdx
[warning] 1-1:
Missing newline character at end of file
[warning] 1-1:
Must have required property 'description' • /home/runner/work/docs/docs/utils/schemas/page.schema.yaml • #/requiredpages/builders/app-developers/bridging.mdx
[warning] 1-1:
Missing newline character at end of file
[warning] 1-1:
Must have required property 'description' • /home/runner/work/docs/docs/utils/schemas/page.schema.yaml • #/requiredpages/builders/app-developers/contracts.mdx
[warning] 1-1:
Missing newline character at end of file
[warning] 1-1:
Must have required property 'description' • /home/runner/work/docs/docs/utils/schemas/page.schema.yaml • #/requiredpages/builders/app-developers/tools.mdx
[warning] 1-1:
Missing newline character at end of file
[warning] 1-1:
Must have required property 'description' • /home/runner/work/docs/docs/utils/schemas/page.schema.yaml • #/requiredpages/builders/app-developers/transactions.mdx
[warning] 1-1:
Missing newline character at end of file
[warning] 1-1:
Must have required property 'description' • /home/runner/work/docs/docs/utils/schemas/page.schema.yaml • #/required
🪛 LanguageTool
pages/builders/app-developers/bridging.mdx
[uncategorized] ~10-~10: Possible missing article found.
Context: ... using the standard bridge. You'll find guide, overview to help you understand and wo...(AI_HYDRA_LEO_MISSING_A)
pages/builders/app-developers/contracts.mdx
[uncategorized] ~10-~10: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...p mainnet system contracts. You'll find guide, tutorial to help you understand and wo...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~10-~10: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...et system contracts. You'll find guide, tutorial to help you understand and work with th...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
pages/builders/app-developers/tools.mdx
[uncategorized] ~10-~10: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...s This section provides information on open source code repo for op stack builders and sup...(EN_COMPOUND_ADJECTIVE_INTERNAL)
pages/builders/chain-operators.mdx
[misspelling] ~10-~10: This word is normally spelled with a hyphen.
Context: ...ures, hacks, management, how to start a self hosted chain, tools and tutorials. You'll find...(EN_COMPOUNDS_SELF_HOSTED)
pages/builders/chain-operators/deploy.mdx
[uncategorized] ~10-~10: Possible missing article found.
Context: ... smart contract deployment. You'll find guide, overview to help you understand and wo...(AI_HYDRA_LEO_MISSING_A)
pages/builders/chain-operators/features.mdx
[uncategorized] ~10-~10: Possible missing article found.
Context: ...einstalls and span batches. You'll find guide, overview to help you understand and wo...(AI_HYDRA_LEO_MISSING_A)
pages/builders/chain-operators/hacks.mdx
[uncategorized] ~10-~10: You might be missing the article “an” here.
Context: ...hacks and settlement hacks. You'll find overview, introduction to help you understand an...(AI_EN_LECTOR_MISSING_DETERMINER_AN)
pages/builders/chain-operators/management.mdx
[uncategorized] ~10-~10: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...shooting: chain operations. You'll find guide, tutorial to help you understand and wo...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~10-~10: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...g: chain operations. You'll find guide, tutorial to help you understand and work with th...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
pages/builders/chain-operators/tutorials.mdx
[grammar] ~10-~10: The verb ‘precompile’ does not usually follow articles like ‘a’. Check that ‘precompile’ is spelled correctly; using ‘precompile’ as a noun may be non-standard.
Context: ...utes to the derivation function, adding a precompile, creating your own l2 rollup testnet, i...(A_INFINITIVE)
[uncategorized] ~10-~10: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...the optimism sdk. You'll find overview, tutorial, guide to help you understand and work ...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
pages/builders/node-operators/tutorials.mdx
[grammar] ~10-~10: Before the countable noun ‘from’ an article or a possessive pronoun is necessary.
Context: ... node with docker, building a node from source and running an op sepolia node from sou...(IN_NN_CC_VBG)
pages/builders/notices.mdx
[uncategorized] ~10-~10: Possible missing article found.
Context: ...hanges and sdk deprecation. You'll find overview, tutorial to help you understand and wo...(AI_HYDRA_LEO_MISSING_AN)
pages/builders/tools.mdx
[uncategorized] ~10-~10: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ... tools and developer tools. You'll find guide, reference, tool, overview to help you ...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
pages/builders/tools/build.mdx
[uncategorized] ~10-~10: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...nnet nft tools and oracles. You'll find guide, reference, tool, api to help you under...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~10-~10: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ... oracles. You'll find guide, reference, tool, api to help you understand and work wi...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
pages/builders/tools/monitor.mdx
[uncategorized] ~10-~10: Possible missing article found.
Context: ...sing pre regenesis history. You'll find guide, tool to help you understand and work w...(AI_HYDRA_LEO_MISSING_A)
pages/chain/identity.mdx
[uncategorized] ~10-~10: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...y This section provides information on build decentralized identity apps with attest...(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
pages/connect/contribute.mdx
[uncategorized] ~10-~10: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...stack and docs style guide. You'll find tutorial, overview, guide to help you understand...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~10-~10: This verb does not appear to agree with the subject. Consider using a different form.
Context: ... guide. You'll find tutorial, overview, guide to help you understand and work with th...(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
pages/connect/resources.mdx
[uncategorized] ~10-~10: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...n provides information on . You'll find concept to help you understand and work with th...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
pages/stack/operators.mdx
[uncategorized] ~10-~10: Possible missing article found.
Context: ...n provides information on . You'll find guide to help you understand and work with th...(AI_HYDRA_LEO_MISSING_A)
pages/stack/operators/features.mdx
[uncategorized] ~10-~10: Possible missing article found.
Context: ...n on op txproxy and proxyd. You'll find guide to help you understand and work with th...(AI_HYDRA_LEO_MISSING_A)
pages/stack/protocol.mdx
[uncategorized] ~10-~10: You might be missing the article “an” here.
Context: ...quencer outages and rollup. You'll find overview, reference, guide to help you understan...(AI_EN_LECTOR_MISSING_DETERMINER_AN)
pages/stack/protocol/features.mdx
[uncategorized] ~10-~10: Possible missing article found.
Context: ...ctionconditional explainer. You'll find guide to help you understand and work with th...(AI_HYDRA_LEO_MISSING_A)
pages/stack/protocol/interop.mdx
[uncategorized] ~10-~10: Possible missing article found.
Context: ...in development environment. You'll find overview, guide, tool to help you understand and...(AI_HYDRA_LEO_MISSING_AN)
pages/stack/protocol/rollup.mdx
[uncategorized] ~10-~10: Possible missing article found.
Context: ...n flow and withdrawal flow. You'll find guide, overview to help you understand and wo...(AI_HYDRA_LEO_MISSING_A)
🔇 Additional comments (75)
pages/stack/operators.mdx (3)
1-4: LGTM: Frontmatter is correctly formatted.The frontmatter includes the appropriate title and language specification.
6-6: LGTM: Imports are correct and necessary.The Card and Cards components are imported from the appropriate library.
8-8: LGTM: Header is appropriate and follows guidelines.The main header "Operators" uses sentence case as required by the coding guidelines.
pages/connect/resources.mdx (2)
1-4: LGTM: Frontmatter is correctly formatted.The frontmatter includes the necessary title and language declaration.
6-6: LGTM: Import statement is correct.The necessary components (Card and Cards) are properly imported from the 'nextra/components' library.
pages/stack/transactions.mdx (2)
1-4: LGTM: Frontmatter is correctly structured.The frontmatter contains the appropriate title and language settings for this document.
6-6: LGTM: Import statement is correct.The Card and Cards components are properly imported from the 'nextra/components' library.
pages/stack/security.mdx (2)
1-4: Frontmatter looks good!The title and language declarations are appropriate and correctly formatted.
6-6: Import statement is correct.The Card and Cards components are properly imported from the 'nextra/components' library.
pages/stack/operators/features.mdx (2)
1-4: LGTM: Frontmatter is correctly formatted.The frontmatter is well-structured with an appropriate title and language specification.
6-6: LGTM: Import statement is correct.The import statement correctly imports the necessary components from the 'nextra/components' library.
pages/builders/tools/connect.mdx (3)
1-4: LGTM: Frontmatter is correctly formatted.The frontmatter contains the appropriate title and language specification.
6-6: LGTM: Imports are correct and necessary.The Card and Cards components are properly imported from the 'nextra/components' package.
8-8:⚠️ Potential issueUpdate H1 header to sentence case.
According to our coding guidelines, H1 headers should use sentence case. Please update the header as follows:
-# Connect +# ConnectLikely invalid or redundant comment.
pages/builders/app-developers/tools.mdx (2)
6-6: LGTM: Import statement is correct.The import statement for the Card and Cards components from 'nextra/components' is properly implemented.
12-15:⚠️ Potential issueAdjust Card titles and verify href attributes.
The Card titles need to be updated to use proper title case, and the href attributes should be verified:
- Update the titles to use proper title case.
- Ensure the href attributes point to valid pages.
Please update the Card components as follows:
<Cards> - <Card title="Open source code repo for op stack builders" href="/builders/app-developers/tools/ecosystem-overview" /> - <Card title="Supersim" href="/builders/app-developers/tools/supersim" /> + <Card title="Open-Source Code Repo for OP Stack Builders" href="/builders/app-developers/tools/ecosystem-overview" /> + <Card title="SuperSim" href="/builders/app-developers/tools/supersim" /> </Cards>Please verify that the following pages exist:
✅ Verification successful
Verified href attributes in Card components.
The
hrefattributes in the Card components have been confirmed to point to existing pages:
/builders/app-developers/tools/ecosystem-overview.mdx/builders/app-developers/tools/supersim.mdxPlease proceed to update the Card titles to use proper title case for consistency with coding guidelines.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Check if the linked pages exist # Test: Check if the ecosystem-overview page exists fd --type file "ecosystem-overview.mdx" pages/builders/app-developers/tools # Test: Check if the supersim page exists fd --type file "supersim.mdx" pages/builders/app-developers/toolsLength of output: 249
pages/chain/testing.mdx (3)
1-4: LGTM: Metadata is correctly formatted and appropriate.The metadata section is well-structured, with an appropriate title and correct language setting.
6-8: LGTM: Import statement and title are correct.The import statement is properly formatted, and the title "Testing" is consistent with the metadata and follows the correct capitalization guidelines for H1 headers.
12-15: LGTM: Card components are well-structured and consistent.The Card components are correctly implemented, with appropriate titles and href attributes. The titles use proper title case as per the coding guidelines.
pages/chain/security.mdx (2)
1-4: LGTM: Frontmatter is correct and appropriate.The frontmatter contains the necessary metadata for the page, including the correct title and language setting.
6-6: LGTM: Import statement is correct and necessary.The
CardandCardscomponents are properly imported from 'nextra/components' and are used in the file.pages/builders/cex-wallet-developers.mdx (1)
6-6: LGTM: Import statement is correctThe import statement for the Card and Cards components is properly implemented.
pages/connect/contribute.mdx (4)
1-4: LGTM: Frontmatter is correctly formatted.The frontmatter section is well-structured with the appropriate fields for title and language.
6-6: LGTM: Import statement is correct.The import statement for the Card and Cards components is properly formatted and placed.
8-8: LGTM: Main heading is correctly formatted.The main heading "Contribute" is properly formatted as an h1 and follows the sentence case guideline for headers.
12-16: Apply title case consistently to card titles and verify href values.The Card components are used correctly, but there are some inconsistencies in the title formatting. Please apply title case consistently to all card titles:
- <Card title="Contribute to optimism docs" href="/connect/contribute/docs-contribute" /> - <Card title="Contribute to the op stack" href="/connect/contribute/stack-contribute" /> + <Card title="Contribute to Optimism Docs" href="/connect/contribute/docs-contribute" /> + <Card title="Contribute to the OP Stack" href="/connect/contribute/stack-contribute" /> <Card title="Docs Style Guide" href="/connect/contribute/style-guide" />Also, please verify that the
hrefvalues for each card are correct and lead to the intended pages.To verify the
hrefvalues, you can run the following script:✅ Verification successful
Href Values Verified Successfully
All
hrefattributes for the Card components have been verified and point to the intended pages.🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Verify the existence of the linked pages for href in "/connect/contribute/docs-contribute" "/connect/contribute/stack-contribute" "/connect/contribute/style-guide"; do if fd -p "pages${href}.*"; then echo "Page exists: $href" else echo "Page not found: $href" fi doneLength of output: 977
pages/builders/notices.mdx (2)
1-4: LGTM: Metadata is correct and well-formatted.The metadata section correctly specifies the title as "Notices" and sets the language to "en-US", which is appropriate for this content.
6-6: LGTM: Correct import of necessary components.The import statement correctly brings in the
CardandCardscomponents from 'nextra/components', which are used to structure the content later in the file.pages/stack/protocol/features.mdx (2)
1-4: LGTM: Frontmatter is correctly formatted.The title and language specification in the frontmatter are appropriate and correctly formatted.
6-6: LGTM: Import statement is correct.The import of Card and Cards components from 'nextra/components' is appropriate for the card layout used in this file.
pages/stack/protocol/interop.mdx (1)
1-4: LGTM: Frontmatter is correctly formatted.The title is properly capitalized, and the language is specified correctly.
pages/builders/app-developers/contracts.mdx (1)
6-6: LGTM: Component imports are correct.The import statement for the
CardandCardscomponents is properly formatted and necessary for the content structure.pages/builders/node-operators/configuration.mdx (3)
1-4: LGTM: Frontmatter is correctly formatted.The frontmatter is well-structured with appropriate title and language settings.
6-6: LGTM: Import statement is correct.The necessary components are properly imported from the 'nextra/components' library.
8-9: LGTM: Content structure and component usage.The overall structure of the content is good. The use of the Cards component to provide links to other pages is appropriate and enhances navigation.
Also applies to: 12-16
pages/builders/tools/build.mdx (3)
1-4: LGTM: Frontmatter is correctly formatted.The frontmatter section is well-structured with appropriate title and language specifications.
6-6: LGTM: Imports are correct and necessary.The import statement for Card and Cards components is properly formatted and these components are used in the file.
12-18: LGTM: Cards component usage and title formatting are correct.The Cards component is used appropriately to structure the list of topics. The Card titles use proper title case as per the coding guidelines.
pages/stack/protocol.mdx (2)
1-4: LGTM: Frontmatter is correctly formatted.The frontmatter contains the appropriate title and language information, which aligns with the file content.
6-6: LGTM: Correct import statement.The import statement for Card and Cards components from 'nextra/components' is correct and necessary for the layout used in this file.
pages/builders/chain-operators/configuration.mdx (3)
1-4: LGTM: Frontmatter is correctly formatted.The frontmatter contains the appropriate title and language settings. The title case is correctly applied.
6-6: LGTM: Import statement is correct.The Card and Cards components are properly imported from the 'nextra/components' package.
12-17: LGTM: Card components are well-structured.The Card components are correctly implemented within the Cards wrapper. Each Card has an appropriate title in proper title case and a corresponding href. The structure provides clear navigation to related configuration topics.
pages/builders/node-operators/tutorials.mdx (2)
1-4: LGTM: Frontmatter is correctly formatted.The title and language specification in the frontmatter are appropriate and correctly formatted.
6-8: LGTM: Import statement and main header are correct.The import statement for the Card components is appropriate, and the main header "Tutorials" follows the sentence case guideline for H1 headers.
pages/builders/chain-operators/tools.mdx (2)
1-4: LGTM: Frontmatter is correctly formatted and contains appropriate information.The title and language specification are correctly set. The title case for "Tools" adheres to the coding guidelines.
6-6: LGTM: Import statement is correct and necessary.The Card and Cards components are properly imported from 'nextra/components' and are used in the file.
pages/builders.mdx (2)
7-7: LGTM: Import statement is correct.The import of
CardandCardscomponents from 'nextra/components' is properly done and necessary for the content structure.
9-9: LGTM: Main header is correctly formatted.The main header "Builders" is properly capitalized and follows the guidelines for H1 headers.
pages/builders/node-operators/management.mdx (4)
1-4: LGTM: Frontmatter is correctly formatted.The frontmatter contains the necessary information with proper capitalization and language specification.
6-6: LGTM: Import statement is correct.The necessary components are imported from the correct package.
8-8: LGTM: Main header is correctly formatted.The H1 header "Management" is properly capitalized and consistent with the frontmatter title.
12-18: LGTM: Cards component is correctly implemented.The Cards component is well-structured with appropriate titles and href attributes for each Card. The title case is correctly applied as per the coding guidelines.
pages/builders/chain-operators/features.mdx (2)
1-4: LGTM: Frontmatter is correctly formatted.The title follows the sentence case guideline for headers, and the language specification is correct.
6-6: LGTM: Import statement is correct.The import statement correctly imports the necessary components from the Nextra library.
pages/builders/chain-operators/hacks.mdx (2)
1-4: LGTM: Frontmatter is correctly defined.The frontmatter is properly structured with the correct title and language attributes.
6-6: LGTM: Correct import statement.The import statement for Card and Cards components from 'nextra/components' is correct and necessary for the layout structure used in this file.
pages/builders/app-developers.mdx (1)
6-6: LGTM: Import statement is correctThe import statement for the Card and Cards components is properly formatted and necessary for the content structure.
pages/builders/app-developers/transactions.mdx (1)
6-7: LGTM: Import statement is correct.The import of Card and Cards components from 'nextra/components' is appropriate for the content structure.
pages/stack/protocol/fault-proofs.mdx (3)
1-4: LGTM: Frontmatter is correctly formatted.The frontmatter is well-structured with an appropriate title in title case and correct language specification.
6-6: LGTM: Import statement is correct.The import of Card and Cards components from 'nextra/components' is properly formatted and necessary for the content structure.
8-8: LGTM: Title is correctly formatted.The H1 header "Fault Proofs" is appropriately capitalized as it's a proper noun.
pages/chain/identity.mdx (3)
1-4: LGTM: Frontmatter is correct and appropriate.The frontmatter contains the correct title "Identity" and appropriate language setting "en-US" for the content.
6-6: LGTM: Import statement is correct.The import of Card and Cards components from 'nextra/components' is appropriate for the usage in this file.
12-21: Verify the existence of linked pages.Please ensure that all the pages referenced in the Card components' href attributes exist in the documentation structure. This will prevent broken links and improve user navigation.
Run the following script to verify the existence of the linked pages:
✅ Verification successful
All linked pages exist.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the existence of pages linked in the Cards component # Test: Check if the linked pages exist for page in about-attestations applications contracts-eas individuals organizations overview projects schemas; do if [ ! -f "pages/chain/identity/$page.mdx" ]; then echo "Warning: File pages/chain/identity/$page.mdx does not exist" fi doneLength of output: 1329
pages/builders/chain-operators/management.mdx (2)
1-4: LGTM: Frontmatter is correctly formatted.The frontmatter section is well-structured with the appropriate title and language specification.
6-6: LGTM: Import statement is correct.The import statement for the Card and Cards components is properly formatted and necessary for the content structure.
pages/builders/chain-operators.mdx (1)
6-6: LGTM!The import statement is correct and imports the necessary components for the page layout.
pages/builders/node-operators.mdx (2)
1-4: Frontmatter looks good!The title "Node Operators" follows proper title case, and the language setting is appropriate for English content.
6-6: Import statement is correct.The import of Card and Cards components from 'nextra/components' is appropriate for the usage in this file.
pages/builders/chain-operators/tutorials.mdx (3)
1-4: LGTM: Frontmatter is correctly formatted.The frontmatter contains the necessary information (title and language) and is properly structured.
6-6: LGTM: Correct import statement.The import statement for the Nextra components (Card and Cards) is properly formatted and necessary for the content structure.
1-19: Overall assessment: Good structure, minor improvements needed.The file provides a well-structured overview of tutorials for chain operators. The use of Nextra components enhances the presentation. However, there are a few areas that require attention:
- The main content paragraph needs revision for clarity and consistency.
- Card titles should use proper title case.
- Ensure consistent capitalization in href values.
Once these minor issues are addressed, the file will be in excellent shape and ready for use.
🧰 Tools
🪛 LanguageTool
[grammar] ~10-~10: The verb ‘precompile’ does not usually follow articles like ‘a’. Check that ‘precompile’ is spelled correctly; using ‘precompile’ as a noun may be non-standard.
Context: ...utes to the derivation function, adding a precompile, creating your own l2 rollup testnet, i...(A_INFINITIVE)
[uncategorized] ~10-~10: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...the optimism sdk. You'll find overview, tutorial, guide to help you understand and work ...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
pages/builders/app-developers/tutorials.mdx (2)
1-4: LGTM: Frontmatter is correct and appropriate.The title "Tutorials" accurately reflects the content, and the language specification "en-US" is correct for English (United States).
6-6: LGTM: Import statement is correct.The import statement for Card and Cards components from 'nextra/components' is syntactically correct and these components are used in the file.
|
|
||
| # Operators | ||
|
|
||
| This section provides information on . You'll find guide to help you understand and work with these topics. |
There was a problem hiding this comment.
Improve the introductory paragraph.
The current sentence has grammatical issues and lacks specificity. Consider revising it to provide more context and correct the grammar.
Here's a suggested improvement:
- This section provides information on . You'll find guide to help you understand and work with these topics.
+ This section provides information on operators in the OP Stack ecosystem. You'll find guides to help you understand and work with various operator-related topics.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| This section provides information on . You'll find guide to help you understand and work with these topics. | |
| This section provides information on operators in the OP Stack ecosystem. You'll find guides to help you understand and work with various operator-related topics. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~10-~10: Possible missing article found.
Context: ...n provides information on . You'll find guide to help you understand and work with th...(AI_HYDRA_LEO_MISSING_A)
| # Transactions | ||
|
|
||
| This section provides information on . You'll find reference to help you understand and work with these topics. |
There was a problem hiding this comment.
Improve content clarity and consistency.
The main content and Card title have the following issues:
- The description is incomplete and lacks specific information about the topics covered.
- The sentence structure in the description needs improvement.
- Inconsistent capitalization of "OP Mainnet" in the Card title.
Please apply the following changes:
- Complete the description by specifying the transaction-related topics covered:
-This section provides information on . You'll find reference to help you understand and work with these topics.
+This section provides information on transactions in the OP Stack. You'll find references to help you understand and work with transaction-related topics, including fees and processing.- Update the Card title for consistency:
- <Card title="Transaction fees on op mainnet" href="/stack/transactions/fees" />
+ <Card title="Transaction Fees on OP Mainnet" href="/stack/transactions/fees" />Also applies to: 13-13
pages/stack/transactions.mdx
Outdated
| <Cards> | ||
| <Card title="Transaction fees on op mainnet" href="/stack/transactions/fees" /> | ||
| </Cards> |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Consider adding more transaction-related topics.
The current Cards component contains only one Card for transaction fees. To provide a more comprehensive overview of transactions in the OP Stack, consider adding more Cards for related topics.
Here's an example of how you could expand the Cards component:
<Cards>
<Card title="Transaction Fees on OP Mainnet" href="/stack/transactions/fees" />
<Card title="Transaction Types" href="/stack/transactions/types" />
<Card title="Transaction Lifecycle" href="/stack/transactions/lifecycle" />
<Card title="Transaction Finality" href="/stack/transactions/finality" />
</Cards>Please ensure that the corresponding pages for these new topics are created or planned for future content.
pages/stack/operators/features.mdx
Outdated
| # Features | ||
|
|
||
| This section provides information on op txproxy and proxyd. You'll find guide to help you understand and work with these topics. | ||
|
|
||
| <Cards> | ||
| <Card title="Op Txproxy" href="/stack/operators/features/op-txproxy" /> | ||
| <Card title="Proxyd" href="/stack/operators/features/proxyd" /> | ||
| </Cards> |
There was a problem hiding this comment.
Improve grammar and capitalization in the description.
The description has a grammatical error and inconsistent capitalization. Please consider the following changes:
- Add the missing article "a" before "guide".
- Capitalize "Op Txproxy" and "Proxyd" for consistency with the Card titles.
Here's the suggested revision:
- This section provides information on op txproxy and proxyd. You'll find guide to help you understand and work with these topics.
+ This section provides information on Op Txproxy and Proxyd. You'll find a guide to help you understand and work with these topics.The Cards component and Card elements are correctly implemented.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| # Features | |
| This section provides information on op txproxy and proxyd. You'll find guide to help you understand and work with these topics. | |
| <Cards> | |
| <Card title="Op Txproxy" href="/stack/operators/features/op-txproxy" /> | |
| <Card title="Proxyd" href="/stack/operators/features/proxyd" /> | |
| </Cards> | |
| # Features | |
| This section provides information on Op Txproxy and Proxyd. You'll find a guide to help you understand and work with these topics. | |
| <Cards> | |
| <Card title="Op Txproxy" href="/stack/operators/features/op-txproxy" /> | |
| <Card title="Proxyd" href="/stack/operators/features/proxyd" /> | |
| </Cards> |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~10-~10: Possible missing article found.
Context: ...n on op txproxy and proxyd. You'll find guide to help you understand and work with th...(AI_HYDRA_LEO_MISSING_A)
pages/builders/tools/connect.mdx
Outdated
| <Card title="Networks" href="/builders/tools/connect/networks" /> | ||
| <Card title="Rpc & node providers" href="/builders/tools/connect/rpc-providers" /> |
There was a problem hiding this comment.
Update Card titles to proper title case.
According to our coding guidelines, titles should use proper title case. Please update the Card titles as follows:
- <Card title="Networks" href="/builders/tools/connect/networks" />
- <Card title="Rpc & node providers" href="/builders/tools/connect/rpc-providers" />
+ <Card title="Networks" href="/builders/tools/connect/networks" />
+ <Card title="RPC & Node Providers" href="/builders/tools/connect/rpc-providers" />Committable suggestion was skipped due to low confidence.
| --- | ||
| title: Tutorials | ||
| lang: en-US | ||
| --- | ||
|
|
||
| import { Card, Cards } from 'nextra/components' | ||
|
|
||
| # Tutorials | ||
|
|
||
| This section provides information on bridging erc 20 tokens to op mainnet with the optimism sdk, bridging eth to op mainnet with the optimism sdk, communicating between op mainnet and ethereum in solidity, deploying your first contract on op mainnet, estimating transaction costs on op mainnet, tracing deposits and withdrawals, viewing deposits and withdrawals by address, triggering op mainnet transactions from ethereum, bridging your custom erc 20 token using the standard bridge and bridging your standard erc 20 token using the standard bridge. You'll find tutorial to help you understand and work with these topics. | ||
|
|
||
| <Cards> | ||
| <Card title="Bridging erc 20 tokens to op mainnet with the optimism sdk" href="/builders/app-developers/tutorials/cross-dom-bridge-erc20" /> | ||
| <Card title="Bridging eth to op mainnet with the optimism sdk" href="/builders/app-developers/tutorials/cross-dom-bridge-eth" /> | ||
| <Card title="Communicating between op mainnet and ethereum in solidity" href="/builders/app-developers/tutorials/cross-dom-solidity" /> | ||
| <Card title="Deploying your first contract on op mainnet" href="/builders/app-developers/tutorials/first-contract" /> | ||
| <Card title="Estimating transaction costs on op mainnet" href="/builders/app-developers/tutorials/sdk-estimate-costs" /> | ||
| <Card title="Tracing deposits and withdrawals" href="/builders/app-developers/tutorials/sdk-trace-txns" /> | ||
| <Card title="Viewing deposits and withdrawals by address" href="/builders/app-developers/tutorials/sdk-view-txns" /> | ||
| <Card title="Triggering op mainnet transactions from ethereum" href="/builders/app-developers/tutorials/send-tx-from-eth" /> | ||
| <Card title="Bridging your custom erc 20 token using the standard bridge" href="/builders/app-developers/tutorials/standard-bridge-custom-token" /> | ||
| <Card title="Bridging your standard erc 20 token using the standard bridge" href="/builders/app-developers/tutorials/standard-bridge-standard-token" /> | ||
| </Cards> |
There was a problem hiding this comment.
Summary of improvements needed for this file.
While the overall structure of the file is correct, there are several areas that need improvement:
- The introduction paragraph should be revised for better readability and proper capitalization of technical terms.
- Card titles should use title case, full forms of abbreviations, and consistent terminology (e.g., "OP Stack" instead of "op mainnet").
- Ensure proper capitalization of technical terms and proper nouns throughout the file.
These changes will improve the consistency and professionalism of the documentation, aligning it better with the coding guidelines and PR objectives.
| @@ -15,7 +15,7 @@ This guide provides important information you should be aware of when building a | |||
| <Callout> | |||
| Custom bridges can bring a significant amount of complexity and risk to any project. | |||
| Before you commit to a custom bridge, be sure that the [Standard Bridge](./standard-bridge) definitely does not support your use case. | |||
| [Building a custom bridged token](/builders/app-developers/tutorials/standard-bridge-custom-token) is often sufficient for projects that need more flexibility. | |||
| [Building a custom bridged token](/builders/app-developers/tutorials/standard-bridge-custom-tokennnnyd) is often sufficient for projects that need more flexibility. | |||
There was a problem hiding this comment.
Fix the broken link URL.
The URL for "Building a custom bridged token" appears to be incorrect. The current URL ends with "tokennnnyd", which seems to be a typo.
Please correct the URL as follows:
- [Building a custom bridged token](/builders/app-developers/tutorials/standard-bridge-custom-tokennnnyd) is often sufficient for projects that need more flexibility.
+ [Building a custom bridged token](/builders/app-developers/tutorials/standard-bridge-custom-token) is often sufficient for projects that need more flexibility.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| [Building a custom bridged token](/builders/app-developers/tutorials/standard-bridge-custom-tokennnnyd) is often sufficient for projects that need more flexibility. | |
| [Building a custom bridged token](/builders/app-developers/tutorials/standard-bridge-custom-token) is often sufficient for projects that need more flexibility. |
| @@ -27,7 +27,7 @@ | |||
|
|
|||
| If you choose not to extend the `StandardBridge` contract, you may still want to follow the interface that the `StandardBridge` provides. | |||
| Bridges that extend this interface will be compatible with the [Superchain Bridges UI](https://app.optimism.io/bridge). | |||
| You can read more about the design of the Standard Bridge in the guide on [Using the Standard Bridge](./standard-bridge). | |||
| You can read more about the design of the Standard Bridge in the guide on [Using the Standard Bridge](./standard-bridgedgh). | |||
There was a problem hiding this comment.
Correct the link URL for the Standard Bridge guide.
The URL for "Using the Standard Bridge" appears to be incorrect. The current URL ends with "bridgedgh", which seems to be a typo.
Please amend the URL as follows:
-You can read more about the design of the Standard Bridge in the guide on [Using the Standard Bridge](./standard-bridgedgh).
+You can read more about the design of the Standard Bridge in the guide on [Using the Standard Bridge](./standard-bridge).📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| You can read more about the design of the Standard Bridge in the guide on [Using the Standard Bridge](./standard-bridgedgh). | |
| You can read more about the design of the Standard Bridge in the guide on [Using the Standard Bridge](./standard-bridge). |
| function toTitleCase(str: string): string { | ||
| return str.split('-').map(word => | ||
| word.charAt(0).toUpperCase() + word.slice(1).toLowerCase() | ||
| ).join(' '); | ||
| } |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Enhance toTitleCase function to handle additional delimiters
Currently, the toTitleCase function splits the input string using the '-' delimiter. This may not handle other common delimiters like spaces or underscores, which could limit the function's usefulness. Consider modifying the function to handle a broader set of delimiters for improved robustness.
You can adjust the function as follows to handle spaces, hyphens, and underscores:
function toTitleCase(str: string): string {
- return str.split('-').map(word =>
+ return str.split(/[\s-_]+/).map(word =>
word.charAt(0).toUpperCase() + word.slice(1).toLowerCase()
).join(' ');
}📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| function toTitleCase(str: string): string { | |
| return str.split('-').map(word => | |
| word.charAt(0).toUpperCase() + word.slice(1).toLowerCase() | |
| ).join(' '); | |
| } | |
| function toTitleCase(str: string): string { | |
| return str.split(/[\s-_]+/).map(word => | |
| word.charAt(0).toUpperCase() + word.slice(1).toLowerCase() | |
| ).join(' '); | |
| } |
| const matches = file.content.match(keywordRegex); | ||
| return matches ? matches.map(keyword => keyword.toLowerCase()) : []; | ||
| }) |
There was a problem hiding this comment.
Fix keyword extraction logic in generateOverview function
In the generateOverview function, the file.content.match(keywordRegex) without the global flag (/g) will return only the first match, and matches may not be an array suitable for mapping. This can lead to incorrect keyword extraction. Consider adding the global flag to the regular expression and adjusting the logic to properly collect all matches.
Apply the following changes to fix the keyword extraction:
- const keywordRegex = /\b(guide|tutorial|overview|introduction|tool|concept|api|reference)\b/i;
+ const keywordRegex = /\b(guide|tutorial|overview|introduction|tool|concept|api|reference)\b/gi;
const keywords = uniqueArray(
fileInfos.flatMap(file => {
const matches = file.content.match(keywordRegex);
- return matches ? matches.map(keyword => keyword.toLowerCase()) : [];
+ return matches ? matches.map(keyword => keyword.toLowerCase()) : [];
})
);This ensures all occurrences of the keywords are matched and processed correctly.
Committable suggestion was skipped due to low confidence.
There was a problem hiding this comment.
Actionable comments posted: 32
🧹 Outside diff range and nitpick comments (15)
pages/connect/resources.mdx (2)
12-14: LGTM: Cards component is correctly implemented.The Cards component is properly used with a single Card element linking to the Glossary page. The title case for "Glossary" is correct, adhering to the coding guidelines.
Consider adding more Card elements for other relevant resources as they become available, to make this section more comprehensive.
14-14: Add a newline at the end of the file.It's a common best practice to end files with a newline character. Please add an empty line at the end of this file.
pages/builders/tools/monitor.mdx (1)
12-16: Ensure consistent capitalization of "Regenesis".The Card titles look good, but there's an inconsistency in the capitalization of "Regenesis".
<Cards> <Card title="Analytics tools" href="/builders/tools/monitor/analytics-tools" /> - <Card title="Accessing pre Regenesis history" href="/builders/tools/monitor/regenesis-history" /> + <Card title="Accessing pre-Regenesis history" href="/builders/tools/monitor/regenesis-history" /> </Cards>This change ensures consistent capitalization of "Regenesis" and adds a hyphen for better readability.
pages/builders/notices.mdx (1)
8-8: Use sentence case for the main header.According to the coding guidelines, H1 headers should use sentence case. Please update the header as follows:
- # Notices + # NoticesNote that in this case, the capitalization doesn't change because "Notices" is a single word and should be capitalized as the first word of the header.
pages/builders/chain-operators/deploy.mdx (1)
13-17: Enhance card titles for consistency.The card titles should be consistent in their formatting and terminology. Consider applying title case and using "OP Stack" consistently.
Here's a suggested improvement:
- <Card title="Op stack genesis creation" href="/builders/chain-operators/deploy/genesis" /> + <Card title="OP Stack Genesis Creation" href="/builders/chain-operators/deploy/genesis" /> - <Card title="Op stack deployment overview" href="/builders/chain-operators/deploy/overview" /> + <Card title="OP Stack Deployment Overview" href="/builders/chain-operators/deploy/overview" /> - <Card title="Op stack smart contract deployment" href="/builders/chain-operators/deploy/smart-contracts" /> + <Card title="OP Stack Smart Contract Deployment" href="/builders/chain-operators/deploy/smart-contracts" />pages/builders/app-developers/bridging.mdx (1)
8-10: Improve the description textThe description provides a good overview, but there are some minor issues with capitalization and punctuation. Consider the following improvements:
- Capitalize "L1" and "L2" as they are abbreviations for Layer 1 and Layer 2.
- Add an Oxford comma before "and using the standard bridge" for clarity.
- Replace "You'll find guide, overview" with "You'll find guides and overviews".
Apply this diff to improve the description:
-This section provides information on bridging basics, custom bridges, sending data between l1 and l2 and using the standard bridge. You'll find guide, overview to help you understand and work with these topics. +This section provides information on bridging basics, custom bridges, sending data between L1 and L2, and using the standard bridge. You'll find guides and overviews to help you understand and work with these topics.pages/stack/protocol.mdx (2)
8-10: Minor grammatical improvement needed in the overview paragraph.The overview paragraph is clear and informative. However, there's a small grammatical issue that can be improved.
Consider revising the sentence structure for better clarity:
- This section provides information on derivation pipeline, fault proofs, features, interop, sequencer outages and rollup. You'll find overview, reference, guide to help you understand and work with these topics. + This section provides information on the derivation pipeline, fault proofs, features, interoperability, sequencer outages, and rollup. You'll find an overview, references, and guides to help you understand and work with these topics.This revision adds necessary articles, uses the full word "interoperability" for consistency, and improves the sentence structure.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~10-~10: Possible missing article found.
Context: ...quencer outages and rollup. You'll find overview, reference, guide to help you understan...(AI_HYDRA_LEO_MISSING_AN)
12-24: LGTM: Well-structured Cards component with clear navigation.The Cards component is well-implemented, providing clear navigation to various subtopics. The structure is consistent, and the titles use proper capitalization.
For improved consistency, consider updating the "Interop" card title:
- <Card title="Interop" href="/stack/protocol/interop" /> + <Card title="Interoperability" href="/stack/protocol/interop" />This change aligns with the full term used in the overview paragraph and maintains consistency throughout the document.
pages/builders/node-operators/tutorials.mdx (2)
8-8: Use sentence case for the main header.According to our coding guidelines, H1 headers should use sentence case. Please update the header as follows:
- # Tutorials + # TutorialsNote that in this case, the capitalization doesn't change because "Tutorials" is a single word that should be capitalized as the first word in a sentence.
12-20: Update Card titles for consistency with OP naming convention.The Card components are well-structured, but there's an inconsistency in the capitalization of "OP" in the titles. To maintain consistency with the rest of the documentation, please update the titles as follows:
- <Card title="Running an op mainnet node from source" href="/builders/node-operators/tutorials/mainnet" /> + <Card title="Running an OP Mainnet node from source" href="/builders/node-operators/tutorials/mainnet" /> - <Card title="Running an op sepolia node from source" href="/builders/node-operators/tutorials/testnet" /> + <Card title="Running an OP Sepolia node from source" href="/builders/node-operators/tutorials/testnet" />This change ensures that "OP" is consistently capitalized across all references to OP Mainnet and OP Sepolia.
pages/builders/node-operators/management.mdx (1)
12-22: LGTM: Cards section is well-structured.The Cards section is well-organized and follows the proper title case guideline for each Card title. The href attributes are consistent and appear to be correct.
For improved consistency, consider adding a trailing slash to the last href attribute:
- <Card title="Node troubleshooting" href="/builders/node-operators/management/troubleshooting" /> + <Card title="Node troubleshooting" href="/builders/node-operators/management/troubleshooting/" />pages/builders/app-developers.mdx (1)
8-27: LGTM: Content structure and formatting are well-implementedThe main content is well-structured and follows the coding guidelines. The use of Card components for different resources is effective for navigation. The welcome message and titles are appropriately formatted.
Minor suggestion: Consider adding brief descriptions to each Card to provide more context for the linked resources. For example:
- <Card title="Overview" href="/builders/app-developers/overview" /> + <Card title="Overview" href="/builders/app-developers/overview"> + Get a high-level understanding of app development on the OP Stack. + </Card>This change would enhance the user's understanding of each resource before clicking through.
pages/builders/chain-operators/management.mdx (1)
12-24: Card components look good, with a minor suggestion for consistency.The Card components are well-structured and use proper title case. However, for consistency, consider revising the last Card title:
- <Card title="Troubleshooting: chain operations" href="/builders/chain-operators/management/troubleshooting" /> + <Card title="Troubleshooting Chain Operations" href="/builders/chain-operators/management/troubleshooting" />This change maintains consistency with the title case format used in the other Card titles.
words.txt (2)
208-208: Inconsistent capitalization and potential duplication
The term
Proxydis capitalized, which might be inconsistent with other daemon-related terms in the list. Consider using lowercaseproxydfor consistency, unless it's a proper noun or brand name.Both
Sendrawtransactionconditionalandsendrawtransactionconditionalare added. This seems redundant. Consider keeping only the lowercase version to maintain consistency with other function-like terms in the list.Also applies to: 288-288, 322-323
Line range hint
1-375: Overall assessment: Improvements in consistency with minor suggestionsThe changes to this word list generally improve its consistency and usability. The shift towards lowercase for many terms aligns well with common conventions in technical documentation.
A few suggestions were made regarding the capitalization of
Proxydand the potential redundancy ofSendrawtransactionconditional. Addressing these minor points would further enhance the quality of the list.If you'd like assistance in reviewing the entire list for any remaining inconsistencies or in implementing the suggested changes, please let me know.
🧰 Tools
🪛 LanguageTool
[duplication] ~321-~321: Möglicher Tippfehler: ein Wort wird wiederholt
Context: ...f RWAs safedb Schnorr secp SELFDESTRUCT Sendrawtransactionconditional sendrawtransactionconditional seqnr SEQUENCERHTTP sequencerhttp serv ...(GERMAN_WORD_REPEAT_RULE)
[duplication] ~324-~324: Möglicher Tippfehler: ein Wort wird wiederholt
Context: ...nal sendrawtransactionconditional seqnr SEQUENCERHTTP sequencerhttp serv Shapella signup SLLV SLTI SLTIU SL...(GERMAN_WORD_REPEAT_RULE)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (41)
- pages/builders/app-developers.mdx (1 hunks)
- pages/builders/app-developers/bridging.mdx (1 hunks)
- pages/builders/app-developers/contracts.mdx (1 hunks)
- pages/builders/app-developers/tools.mdx (1 hunks)
- pages/builders/app-developers/transactions.mdx (1 hunks)
- pages/builders/app-developers/tutorials.mdx (1 hunks)
- pages/builders/cex-wallet-developers.mdx (1 hunks)
- pages/builders/chain-operators.mdx (1 hunks)
- pages/builders/chain-operators/configuration.mdx (1 hunks)
- pages/builders/chain-operators/deploy.mdx (1 hunks)
- pages/builders/chain-operators/features.mdx (1 hunks)
- pages/builders/chain-operators/hacks.mdx (1 hunks)
- pages/builders/chain-operators/management.mdx (1 hunks)
- pages/builders/chain-operators/tools.mdx (1 hunks)
- pages/builders/chain-operators/tutorials.mdx (1 hunks)
- pages/builders/node-operators.mdx (1 hunks)
- pages/builders/node-operators/configuration.mdx (1 hunks)
- pages/builders/node-operators/management.mdx (1 hunks)
- pages/builders/node-operators/tutorials.mdx (1 hunks)
- pages/builders/notices.mdx (1 hunks)
- pages/builders/tools.mdx (1 hunks)
- pages/builders/tools/build.mdx (1 hunks)
- pages/builders/tools/connect.mdx (1 hunks)
- pages/builders/tools/monitor.mdx (1 hunks)
- pages/builders/tools/op-tools.mdx (1 hunks)
- pages/chain/identity.mdx (1 hunks)
- pages/chain/security.mdx (1 hunks)
- pages/chain/testing.mdx (1 hunks)
- pages/connect/contribute.mdx (1 hunks)
- pages/connect/resources.mdx (1 hunks)
- pages/stack/operators.mdx (1 hunks)
- pages/stack/operators/features.mdx (1 hunks)
- pages/stack/protocol.mdx (1 hunks)
- pages/stack/protocol/fault-proofs.mdx (1 hunks)
- pages/stack/protocol/features.mdx (1 hunks)
- pages/stack/protocol/interop.mdx (1 hunks)
- pages/stack/protocol/rollup.mdx (1 hunks)
- pages/stack/security.mdx (1 hunks)
- pages/stack/transactions.mdx (1 hunks)
- utils/create-breadcrumbs.ts (1 hunks)
- words.txt (4 hunks)
🚧 Files skipped from review as they are similar to previous changes (16)
- pages/builders/chain-operators/features.mdx
- pages/builders/chain-operators/hacks.mdx
- pages/builders/chain-operators/tools.mdx
- pages/builders/node-operators.mdx
- pages/builders/node-operators/configuration.mdx
- pages/builders/tools.mdx
- pages/builders/tools/build.mdx
- pages/builders/tools/connect.mdx
- pages/builders/tools/op-tools.mdx
- pages/chain/security.mdx
- pages/connect/contribute.mdx
- pages/stack/operators.mdx
- pages/stack/protocol/fault-proofs.mdx
- pages/stack/protocol/rollup.mdx
- pages/stack/security.mdx
- pages/stack/transactions.mdx
🧰 Additional context used
📓 Path-based instructions (23)
pages/builders/app-developers.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.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/contracts.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/tools.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/transactions.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/tutorials.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/cex-wallet-developers.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/chain-operators.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/chain-operators/configuration.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/chain-operators/deploy.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/chain-operators/management.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/chain-operators/tutorials.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/node-operators/management.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/node-operators/tutorials.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/notices.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/tools/monitor.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/chain/identity.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/chain/testing.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/connect/resources.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/stack/operators/features.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/stack/protocol.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/stack/protocol/features.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/stack/protocol/interop.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.
"
🪛 GitHub Check: lint
pages/builders/app-developers.mdx
[warning] 1-1:
Must have required property 'description' • /home/runner/work/docs/docs/utils/schemas/page.schema.yaml • #/requiredpages/builders/app-developers/bridging.mdx
[warning] 1-1:
Must have required property 'description' • /home/runner/work/docs/docs/utils/schemas/page.schema.yaml • #/requiredpages/builders/app-developers/contracts.mdx
[warning] 1-1:
Must have required property 'description' • /home/runner/work/docs/docs/utils/schemas/page.schema.yaml • #/requiredpages/builders/app-developers/tools.mdx
[warning] 1-1:
Must have required property 'description' • /home/runner/work/docs/docs/utils/schemas/page.schema.yaml • #/requiredpages/builders/app-developers/transactions.mdx
[warning] 1-1:
Must have required property 'description' • /home/runner/work/docs/docs/utils/schemas/page.schema.yaml • #/requiredpages/builders/app-developers/tutorials.mdx
[warning] 1-1:
Must have required property 'description' • /home/runner/work/docs/docs/utils/schemas/page.schema.yaml • #/requiredpages/builders/cex-wallet-developers.mdx
[warning] 1-1:
Must have required property 'description' • /home/runner/work/docs/docs/utils/schemas/page.schema.yaml • #/requiredpages/builders/chain-operators.mdx
[warning] 1-1:
Must have required property 'description' • /home/runner/work/docs/docs/utils/schemas/page.schema.yaml • #/requiredpages/builders/chain-operators/configuration.mdx
[warning] 1-1:
Must have required property 'description' • /home/runner/work/docs/docs/utils/schemas/page.schema.yaml • #/requiredpages/builders/chain-operators/deploy.mdx
[warning] 1-1:
Must have required property 'description' • /home/runner/work/docs/docs/utils/schemas/page.schema.yaml • #/required
🪛 LanguageTool
pages/builders/app-developers/contracts.mdx
[uncategorized] ~10-~10: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...p mainnet system contracts. You'll find guide, tutorial to help you understand and wo...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~10-~10: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...et system contracts. You'll find guide, tutorial to help you understand and work with th...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
pages/builders/app-developers/tools.mdx
[uncategorized] ~10-~10: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...s This section provides information on open source code repo for op stack builders and sup...(EN_COMPOUND_ADJECTIVE_INTERNAL)
pages/builders/app-developers/transactions.mdx
[uncategorized] ~10-~10: Possible missing article found.
Context: ...oubleshooting transactions. You'll find guide to help you understand and work with th...(AI_HYDRA_LEO_MISSING_A)
pages/builders/app-developers/tutorials.mdx
[uncategorized] ~10-~10: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ... using the standard bridge. You'll find tutorial to help you understand and work with th...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
pages/builders/chain-operators.mdx
[misspelling] ~10-~10: This word is normally spelled with a hyphen.
Context: ...ures, hacks, management, how to start a self hosted chain, tools and tutorials. You'll find...(EN_COMPOUNDS_SELF_HOSTED)
[uncategorized] ~10-~10: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...chain, tools and tutorials. You'll find tool, api, overview, guide, introduction to ...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
pages/builders/chain-operators/management.mdx
[uncategorized] ~10-~10: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...shooting: chain operations. You'll find guide, tutorial to help you understand and wo...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~10-~10: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...g: chain operations. You'll find guide, tutorial to help you understand and work with th...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
pages/builders/chain-operators/tutorials.mdx
[grammar] ~10-~10: The verb ‘precompile’ does not usually follow articles like ‘a’. Check that ‘precompile’ is spelled correctly; using ‘precompile’ as a noun may be non-standard.
Context: ...utes to the derivation function, adding a precompile, creating your own l2 rollup testnet, i...(A_INFINITIVE)
pages/builders/node-operators/management.mdx
[uncategorized] ~10-~10: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...leshooting. You'll find api, reference, guide to help you understand and work with th...(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
pages/builders/node-operators/tutorials.mdx
[grammar] ~10-~10: Before the countable noun ‘from’ an article or a possessive pronoun is necessary.
Context: ... node with docker, building a node from source and running an op sepolia node from sou...(IN_NN_CC_VBG)
[uncategorized] ~10-~10: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...p sepolia node from source. You'll find tutorial, guide to help you understand and work ...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~10-~10: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...node from source. You'll find tutorial, guide to help you understand and work with th...(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
pages/builders/notices.mdx
[uncategorized] ~10-~10: Possible missing article found.
Context: ...hanges and sdk deprecation. You'll find overview, tutorial to help you understand and wo...(AI_HYDRA_LEO_MISSING_AN)
pages/builders/tools/monitor.mdx
[uncategorized] ~10-~10: Possible missing article found.
Context: ...sing pre regenesis history. You'll find guide, tool to help you understand and work w...(AI_HYDRA_LEO_MISSING_A)
pages/chain/identity.mdx
[uncategorized] ~10-~10: The preposition ‘to’ seems more likely in this position.
Context: ...tity This section provides information on build decentralized identity apps with ...(AI_HYDRA_LEO_REPLACE_ON_TO)
[uncategorized] ~10-~10: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...y This section provides information on build decentralized identity apps with attest...(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
[uncategorized] ~10-~10: Possible missing article found.
Context: ...tion, projects and schemas. You'll find guide, reference, overview to help you unders...(AI_HYDRA_LEO_MISSING_A)
pages/chain/testing.mdx
[uncategorized] ~10-~10: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...esting apps for op mainnet. You'll find tutorial, guide to help you understand and work ...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~10-~10: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...s for op mainnet. You'll find tutorial, guide to help you understand and work with th...(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
pages/connect/resources.mdx
[uncategorized] ~10-~10: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...n provides information on . You'll find concept to help you understand and work with th...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
pages/stack/operators/features.mdx
[uncategorized] ~10-~10: Possible missing article found.
Context: ...n on op txproxy and proxyd. You'll find guide to help you understand and work with th...(AI_HYDRA_LEO_MISSING_A)
pages/stack/protocol.mdx
[uncategorized] ~10-~10: Possible missing article found.
Context: ...quencer outages and rollup. You'll find overview, reference, guide to help you understan...(AI_HYDRA_LEO_MISSING_AN)
pages/stack/protocol/features.mdx
[uncategorized] ~10-~10: Possible missing article found.
Context: ...ctionconditional explainer. You'll find guide to help you understand and work with th...(AI_HYDRA_LEO_MISSING_A)
pages/stack/protocol/interop.mdx
[uncategorized] ~10-~10: You might be missing the article “the” here.
Context: ...p This section provides information on anatomy of a cross chain message, interoperabil...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~10-~10: You might be missing the article “an” here.
Context: ...in development environment. You'll find overview, guide, tool to help you understand and...(AI_EN_LECTOR_MISSING_DETERMINER_AN)
words.txt
[style] ~288-~288: Möchten Sie die modernere Schreibweise „proxid“ verwenden?
Context: ...ze productionized Protip Proxied Proxyd proxyd pseudorandomly QRNG Quicknode quicknode...(I_ANSTATT_Y)
[duplication] ~372-~372: Möglicher Tippfehler: ein Wort wird wiederholt
Context: ...rustlessly trustrpc txfeecap txmgr txns TXPOOL txpool Txproxy txproxy uncountered Unprotect u...(GERMAN_WORD_REPEAT_RULE)
[duplication] ~374-~374: Möglicher Tippfehler: ein Wort wird wiederholt
Context: ...strpc txfeecap txmgr txns TXPOOL txpool Txproxy txproxy uncountered Unprotect unsubmitted UPNP ...(GERMAN_WORD_REPEAT_RULE)
🔇 Additional comments (60)
pages/connect/resources.mdx (2)
1-4: LGTM: Frontmatter is correctly formatted.The frontmatter contains the appropriate title and language declaration for a resources page.
6-6: LGTM: Import statement is correct.The import statement correctly brings in the necessary components (Card and Cards) from the 'nextra/components' library.
pages/stack/operators/features.mdx (5)
1-4: LGTM: Metadata is correctly formatted.The metadata section is properly structured with an appropriate title and correct language specification.
6-6: LGTM: Imports are correct and necessary.The import statement for Card and Cards components is properly formatted and essential for the content structure.
8-8: LGTM: Title is consistent and correctly formatted.The H1 header "Features" matches the metadata title and adheres to the sentence case guideline for headers.
12-16: LGTM: Cards component is correctly implemented.The Cards component and its Card elements are properly structured with appropriate titles and href attributes.
10-10:⚠️ Potential issueImprove grammar, capitalization, and formality in the description.
The description requires several improvements for clarity and consistency:
- Add the missing article "a" before "guide".
- Capitalize "Op Txproxy" and "Proxyd" for consistency with the Card titles.
- Replace the contraction "You'll" with "You will" for a more formal tone.
Here's the suggested revision:
- This section provides information on op txproxy and proxyd. You'll find guide to help you understand and work with these topics. + This section provides information on Op Txproxy and Proxyd. You will find a guide to help you understand and work with these topics.🧰 Tools
🪛 LanguageTool
[uncategorized] ~10-~10: Possible missing article found.
Context: ...n on op txproxy and proxyd. You'll find guide to help you understand and work with th...(AI_HYDRA_LEO_MISSING_A)
pages/builders/tools/monitor.mdx (3)
1-4: LGTM: Frontmatter is correctly formatted.The frontmatter is well-structured with the appropriate title and language setting.
6-6: LGTM: Correct import statement.The import of Card and Cards components from 'nextra/components' is appropriate for the usage in this file.
8-8: LGTM: Main header follows guidelines.The main header "Monitor" correctly uses sentence case as per the coding guidelines.
pages/builders/app-developers/tools.mdx (2)
6-6: LGTM: Imports are correctThe import statement for Card and Cards components from 'nextra/components' is correct and appropriate for the content structure.
1-4:⚠️ Potential issueAdd a 'description' property to the frontmatter
To improve SEO and provide a brief summary of the page content, please add a 'description' property to the frontmatter. You can use the following example:
--- title: Tools lang: en-US +description: Information on open-source code repositories for OP Stack builders and SuperSim. ---Likely invalid or redundant comment.
🧰 Tools
🪛 GitHub Check: lint
[warning] 1-1:
Must have required property 'description' • /home/runner/work/docs/docs/utils/schemas/page.schema.yaml • #/requiredpages/chain/testing.mdx (3)
1-4: LGTM: Frontmatter is correctly formatted.The frontmatter includes the necessary title and language information, adhering to the expected format.
8-8: LGTM: Title follows guidelines.The H1 header "Testing" uses sentence case, which aligns with the coding guidelines for headers.
12-16: LGTM: Card components are correctly implemented.The Card components are used appropriately with proper titles and href attributes. The titles follow the sentence case guideline for body content and short phrases in links.
pages/builders/cex-wallet-developers.mdx (3)
6-6: LGTM: Import statement is correctThe import statement correctly imports the necessary components from 'nextra/components'.
8-10: Update header, terminology, and fix grammarAs mentioned in a previous review, there are issues that need to be addressed:
- Use proper capitalization for "CEX" in the header.
- Replace "op mainnet" with "OP Stack" as per the PR objectives.
- Fix the grammatical error in the description.
Apply these changes:
-# Cex Wallet Developers +# CEX Wallet Developers -This section provides information on supporting op mainnet in your exchange and supporting op mainnet in your wallet. You'll find guide to help you understand and work with these topics. +This section provides information on supporting OP Stack in your exchange and supporting OP Stack in your wallet. You'll find guides to help you understand and work with these topics.
12-16: Update Card titles and hrefsAs mentioned in a previous review, the Card titles should use title case, and the terminology should be updated:
Apply these changes to the Cards component:
<Cards> - <Card title="Supporting op mainnet in your exchange" href="/builders/cex-wallet-developers/cex-support" /> - <Card title="Supporting op mainnet in your wallet" href="/builders/cex-wallet-developers/wallet-support" /> + <Card title="Supporting OP Stack in Your Exchange" href="/builders/cex-wallet-developers/cex-support" /> + <Card title="Supporting OP Stack in Your Wallet" href="/builders/cex-wallet-developers/wallet-support" /> </Cards>pages/builders/notices.mdx (4)
1-4: LGTM: Frontmatter is correctly formatted.The frontmatter section is properly structured with the title and language specified correctly.
6-6: LGTM: Correct import statement.The import statement correctly imports the necessary components from 'nextra/components'.
10-10:⚠️ Potential issueImprove grammar and capitalization in the overview paragraph.
The overview paragraph has some grammatical issues and inconsistent capitalization. Please revise as follows:
- This section provides information on preparing for fault proofs breaking changes, preparing for granite breaking changes and sdk deprecation. You'll find overview, tutorial to help you understand and work with these topics. + This section provides information on preparing for fault proofs breaking changes, preparing for granite breaking changes, and SDK deprecation. You'll find an overview and tutorials to help you understand and work with these topics.This revision:
- Adds the Oxford comma before "and SDK deprecation"
- Capitalizes "SDK" as it's an acronym
- Adds the article "an" before "overview"
- Changes "tutorial" to plural "tutorials" to match the multiple topics mentioned
- Fixes the subject-verb agreement
🧰 Tools
🪛 LanguageTool
[uncategorized] ~10-~10: Possible missing article found.
Context: ...hanges and sdk deprecation. You'll find overview, tutorial to help you understand and wo...(AI_HYDRA_LEO_MISSING_AN)
12-18:⚠️ Potential issueEnsure consistent capitalization in card titles.
The card titles should use consistent capitalization. According to the coding guidelines, we should use proper title case for headers, buttons, tab names, page names, and links. Please update the card titles as follows:
<Cards> - <Card title="Preparing for fault proofs breaking changes" href="/builders/notices/fp-changes" /> - <Card title="Preparing for granite breaking changes" href="/builders/notices/granite-changes" /> - <Card title="Sdk Deprecation" href="/builders/notices/sdk-deprecation" /> + <Card title="Preparing for Fault Proofs Breaking Changes" href="/builders/notices/fp-changes" /> + <Card title="Preparing for Granite Breaking Changes" href="/builders/notices/granite-changes" /> + <Card title="SDK Deprecation" href="/builders/notices/sdk-deprecation" /> </Cards>This revision:
- Applies proper title case to all card titles
- Corrects "Sdk" to "SDK" as it's an acronym
pages/stack/protocol/features.mdx (4)
1-4: Frontmatter looks good!The title and language specification are correctly formatted and appropriate for the content.
6-6: Imports are correct and necessary.The Card and Cards components are properly imported from 'nextra/components' for use in the card layout.
8-10:⚠️ Potential issueImprove capitalization and grammar in the overview paragraph.
While the header is correct, the overview paragraph still needs improvements:
- Capitalize proper nouns.
- Add an article before "guide".
- Use the Oxford comma for better clarity.
- Use sentence case for the paragraph content.
Here's a suggested revision:
- This section provides information on alt da mode explainer, custom gas token explainer and sendrawtransactionconditional explainer. You'll find guide to help you understand and work with these topics. + This section provides information on Alt DA Mode Explainer, Custom Gas Token Explainer, and SendRawTransactionConditional Explainer. You'll find a guide to help you understand and work with these topics.🧰 Tools
🪛 LanguageTool
[uncategorized] ~10-~10: Possible missing article found.
Context: ...ctionconditional explainer. You'll find guide to help you understand and work with th...(AI_HYDRA_LEO_MISSING_A)
12-18:⚠️ Potential issueApply title case to card titles for consistency.
The card layout is correctly implemented, but the titles need to be in title case as per the coding guidelines. Here's a suggested revision:
<Cards> - <Card title="Alt Da mode explainer" href="/stack/protocol/features/alt-da-mode" /> - <Card title="Custom gas token explainer" href="/stack/protocol/features/custom-gas-token" /> - <Card title="Sendrawtransactionconditional explainer" href="/stack/protocol/features/send-raw-transaction-conditional" /> + <Card title="Alt DA Mode Explainer" href="/stack/protocol/features/alt-da-mode" /> + <Card title="Custom Gas Token Explainer" href="/stack/protocol/features/custom-gas-token" /> + <Card title="SendRawTransactionConditional Explainer" href="/stack/protocol/features/send-raw-transaction-conditional" /> </Cards>pages/builders/chain-operators/deploy.mdx (1)
6-6: LGTM: Import statement is correct.The import of Card and Cards components from 'nextra/components' is properly done and necessary for the content below.
pages/stack/protocol/interop.mdx (5)
1-4: LGTM: Frontmatter is correct and properly formatted.The title and language settings in the frontmatter are appropriate and correctly formatted.
6-6: LGTM: Import statement is correct.The import statement for the Card and Cards components is properly formatted and necessary for the content.
8-8: LGTM: Header is correctly formatted.The H1 header "Interop" is properly formatted. As noted in a previous review, no change is needed since "Interop" is a proper noun and should remain capitalized.
10-10:⚠️ Potential issueImprove grammar and clarity in the introductory paragraph.
Please revise the paragraph to enhance grammar, punctuation, and overall clarity. Here's a suggested revision based on the previous review comment:
-This section provides information on anatomy of a cross chain message, interoperability explainer and supersim multichain development environment. You'll find overview, guide, tool to help you understand and work with these topics. +This section provides information on the anatomy of a cross-chain message, an interoperability explainer, and the Supersim multichain development environment. You'll find an overview, guide, and tools to help you understand and work with these topics.This revision:
- Adds missing articles
- Corrects hyphenation of "cross-chain"
- Removes extra spaces
- Improves overall sentence structure and clarity
- Uses proper capitalization for "Supersim"
🧰 Tools
🪛 LanguageTool
[uncategorized] ~10-~10: You might be missing the article “the” here.
Context: ...p This section provides information on anatomy of a cross chain message, interoperabil...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~10-~10: You might be missing the article “an” here.
Context: ...in development environment. You'll find overview, guide, tool to help you understand and...(AI_EN_LECTOR_MISSING_DETERMINER_AN)
12-18:⚠️ Potential issueApply title case to Card titles consistently.
Please update the Card titles to use consistent title case formatting. Here's a suggested revision based on the previous review comment:
<Cards> - <Card title="Anatomy of a cross Chain message" href="/stack/protocol/interop/cross-chain-message" /> - <Card title="Interoperability explainer " href="/stack/protocol/interop/explainer" /> - <Card title="Supersim multichain development environment" href="/stack/protocol/interop/supersim" /> + <Card title="Anatomy of a Cross-Chain Message" href="/stack/protocol/interop/cross-chain-message" /> + <Card title="Interoperability Explainer" href="/stack/protocol/interop/explainer" /> + <Card title="Supersim Multichain Development Environment" href="/stack/protocol/interop/supersim" /> </Cards>These changes:
- Apply title case to all Card titles
- Correct the hyphenation of "Cross-Chain"
- Remove trailing space in the second Card title
- Ensure consistent capitalization across all titles
pages/builders/app-developers/contracts.mdx (2)
6-6: LGTM: Correct import statement.The import statement for the Card and Cards components is correct and necessary for their usage in the file.
8-8:⚠️ Potential issueUse sentence case for the main title.
As per the coding guidelines, H1 headers should use sentence case.
Please update the title as follows:
-# Contracts +# ContractsLikely invalid or redundant comment.
pages/builders/app-developers/bridging.mdx (2)
6-6: LGTM: Import statement is correctThe import statement for the Card and Cards components is properly formatted and necessary for the content structure.
12-20: LGTM: Cards component is well-structuredThe Cards component is correctly implemented with four Card components, each having appropriate titles and href attributes. The titles use proper capitalization, and the hrefs follow a consistent pattern for navigation within the documentation.
pages/stack/protocol.mdx (2)
1-4: LGTM: Frontmatter is correctly formatted.The title and language settings in the frontmatter are appropriate and correctly formatted.
6-6: LGTM: Correct import statement.The import statement for Card and Cards components from 'nextra/components' is correct and necessary for the layout used in this file.
pages/builders/chain-operators/configuration.mdx (2)
6-6: LGTM: Import statement is correctThe import statement correctly imports the necessary components from 'nextra/components'.
12-20: LGTM: Cards component is well-structuredThe Cards component is correctly implemented with four Card elements. Each Card has an appropriate title in title case and a relevant href attribute. This structure provides clear navigation to different configuration topics.
pages/builders/node-operators/tutorials.mdx (2)
1-4: LGTM: Frontmatter is correctly formatted.The frontmatter contains the appropriate title and language setting for the document.
6-6: LGTM: Import statement is correct.The necessary components (Card and Cards) are properly imported from 'nextra/components'.
pages/builders/node-operators/management.mdx (2)
1-4: LGTM: Frontmatter is correctly formatted.The title "Management" follows the proper title case guideline, and the language specification is correct.
6-6: LGTM: Import statement is correct.The import statement for Card and Cards components from 'nextra/components' is properly formatted.
pages/builders/app-developers.mdx (2)
1-4: Add a description to the frontmatterThe frontmatter is missing a 'description' property, which is required according to the page schema. Please add a concise description of the page content.
Here's an example of how you could add the description:
--- title: App Developers lang: en-US +description: Essential resources for app developers building on the OP Stack, including guides for deploying contracts, handling transactions, and cross-chain messaging. ---🧰 Tools
🪛 GitHub Check: lint
[warning] 1-1:
Must have required property 'description' • /home/runner/work/docs/docs/utils/schemas/page.schema.yaml • #/required
6-6: LGTM: Import statement is correctThe import statement for the Card and Cards components is correctly implemented and necessary for the content structure.
pages/chain/identity.mdx (2)
1-4: LGTM: Frontmatter is correct and well-formatted.The title is properly capitalized, and the language is correctly specified.
6-6: LGTM: Import statement is correct.The necessary components (Card and Cards) are properly imported from 'nextra/components'.
pages/builders/chain-operators/management.mdx (3)
1-4: Frontmatter looks good.The title and language settings in the frontmatter are appropriate and correctly formatted.
6-6: Import statement is correct.The Card and Cards components are properly imported from 'nextra/components' and are used in the file.
8-10:⚠️ Potential issueRevise the introduction paragraph for clarity and consistency.
The introduction paragraph requires several improvements:
- Remove the possessive "your" for consistency in communal documentation.
- Fix grammatical issues and inconsistent pluralization.
- Correct punctuation and formatting.
- Apply consistent capitalization.
Please consider the following revision:
- # Management + # Management - This section provides information on chain operator best practices, using blobs, managing your keys, rollup operations, using snap sync for chain operators and troubleshooting: chain operations. You'll find guide, tutorial to help you understand and work with these topics. + This section provides information on chain operator best practices, using blobs, managing keys, rollup operations, using snap sync for chain operators, and troubleshooting chain operations. You'll find guides and tutorials to help you understand and work with these topics.This revision addresses the grammatical issues, removes the possessive "your", fixes list formatting with proper comma usage, corrects pluralization, and applies the Oxford comma as per the coding guidelines.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~10-~10: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...shooting: chain operations. You'll find guide, tutorial to help you understand and wo...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~10-~10: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...g: chain operations. You'll find guide, tutorial to help you understand and work with th...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
pages/builders/chain-operators.mdx (2)
8-8:⚠️ Potential issueUse sentence case for the main header
As per our coding guidelines, H1 headers should use sentence case. Please update the header accordingly.
Apply the following change:
-# Chain Operators +# Chain operators
10-10:⚠️ Potential issueImprove main content formatting and clarity
The main content paragraph needs several improvements for better readability and adherence to our guidelines. Please consider the following changes:
- Break down the long sentence for better readability.
- Hyphenate "self-hosted" as suggested by the static analysis tool.
- Use proper pluralization for consistency.
- Improve overall sentence structure and clarity.
Apply the following changes:
-This section provides information on chain architecture, configuration, deploy, features, hacks, management, how to start a self hosted chain, tools and tutorials. You'll find tool, api, overview, guide, introduction to help you understand and work with these topics. +This section provides information on chain architecture, configuration, deployment, features, hacks, management, and how to start a self-hosted chain. You'll find tools, APIs, overviews, guides, and introductions to help you understand and work with these topics.🧰 Tools
🪛 LanguageTool
[misspelling] ~10-~10: This word is normally spelled with a hyphen.
Context: ...ures, hacks, management, how to start a self hosted chain, tools and tutorials. You'll find...(EN_COMPOUNDS_SELF_HOSTED)
[uncategorized] ~10-~10: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...chain, tools and tutorials. You'll find tool, api, overview, guide, introduction to ...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
pages/builders/chain-operators/tutorials.mdx (2)
1-4: LGTM: Frontmatter is correctly structured.The frontmatter contains the appropriate title and language information.
6-6: LGTM: Import statement is correct.The Card and Cards components are properly imported from the 'nextra/components' package.
words.txt (1)
Line range hint
2-2: Approved: Consistent capitalization changesThe changes from uppercase to lowercase for terms like
accountqueue,blocklogs, andhealthcheckimprove consistency with other terms in the list. This standardization enhances the overall quality and usability of the word list.Also applies to: 55-55, 144-144
🧰 Tools
🪛 LanguageTool
[duplication] ~206-~206: Möglicher Tippfehler: ein Wort wird wiederholt
Context: ...oint MOVN MOVZ MTHI MTLO MULT multiaddr Multichain multichain multiclient multisigs MULTU nethermind ...(GERMAN_WORD_REPEAT_RULE)
utils/create-breadcrumbs.ts (4)
1-5: LGTM: Imports and constants are well-defined.The necessary modules are imported, and the constants provide clear context for the script's operation.
7-11: LGTM: FileInfo interface is well-defined.The interface provides a clear structure for storing file information, which will be useful throughout the script.
19-21: LGTM: uniqueArray function is well-implemented.The function efficiently removes duplicate entries from an array using the filter method with indexOf.
1-138: Overall assessment: Well-implemented utility with room for minor improvements.The
create-breadcrumbs.tsutility is well-structured and effectively generates MDX files from Markdown files. It demonstrates good use of TypeScript features and follows a logical flow. The suggested improvements, primarily in error handling and efficiency, will further enhance its robustness and performance.Great job on implementing this utility! With the proposed enhancements, it will be even more reliable and efficient.
| # Resources | ||
|
|
||
| This section provides information on . You'll find concept to help you understand and work with these topics. |
There was a problem hiding this comment.
Revise the main content for clarity and correctness.
The main content needs improvement in terms of completeness, grammar, and alignment with coding guidelines:
- The description is incomplete and contains grammatical errors.
- The sentence structure needs refinement.
- We should avoid using personal pronouns like "You'll" in communal documentation.
Please consider the following revision:
-# Resources
-
-This section provides information on . You'll find concept to help you understand and work with these topics.
+# Resources
+
+This section provides information on various resources related to the OP Stack ecosystem. It includes concepts to help users understand and work with these topics.This revision:
- Completes the sentence by specifying "various resources related to the OP Stack ecosystem".
- Corrects the grammatical number of "concept" to "concepts".
- Removes the personal pronoun "You'll" and replaces it with "It includes" for a more formal tone.
- Uses "users" instead of "you" to maintain consistency in communal documentation.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| # Resources | |
| This section provides information on . You'll find concept to help you understand and work with these topics. | |
| # Resources | |
| This section provides information on various resources related to the OP Stack ecosystem. It includes concepts to help users understand and work with these topics. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~10-~10: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...n provides information on . You'll find concept to help you understand and work with th...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
|
|
||
| # Monitor | ||
|
|
||
| This section provides information on analytics tools and accessing pre regenesis history. You'll find guide, tool to help you understand and work with these topics. |
There was a problem hiding this comment.
Improve grammar and follow capitalization guidelines in the description.
The description has some issues with grammar and doesn't follow the coding guidelines for capitalization. Consider the following improvements:
- This section provides information on analytics tools and accessing pre regenesis history. You'll find guide, tool to help you understand and work with these topics.
+ This section provides information on analytics tools and accessing pre-Regenesis history. You'll find guides and tools to help you understand and work with these topics.This revision:
- Capitalizes "Regenesis" as it's a proper noun.
- Fixes the grammar by pluralizing "guide" and "tool".
- Adds the missing article "and" before "tools".
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| This section provides information on analytics tools and accessing pre regenesis history. You'll find guide, tool to help you understand and work with these topics. | |
| This section provides information on analytics tools and accessing pre-Regenesis history. You'll find guides and tools to help you understand and work with these topics. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~10-~10: Possible missing article found.
Context: ...sing pre regenesis history. You'll find guide, tool to help you understand and work w...(AI_HYDRA_LEO_MISSING_A)
| <Cards> | ||
| <Card title="Open source code repo for op stack builders" href="/builders/app-developers/tools/ecosystem-overview" /> | ||
|
|
||
| <Card title="Supersim" href="/builders/app-developers/tools/supersim" /> | ||
| </Cards> |
There was a problem hiding this comment.
Improve capitalization and consistency in Card titles
Please update the Card titles to ensure proper capitalization and consistency:
<Cards>
- <Card title="Open source code repo for op stack builders" href="/builders/app-developers/tools/ecosystem-overview" />
+ <Card title="Open-Source Code Repository for OP Stack Builders" href="/builders/app-developers/tools/ecosystem-overview" />
- <Card title="Supersim" href="/builders/app-developers/tools/supersim" />
+ <Card title="SuperSim" href="/builders/app-developers/tools/supersim" />
</Cards>These changes ensure:
- Consistent capitalization of "OP Stack" and "SuperSim".
- Use of title case for Card titles.
- Use of a hyphen for "open-source".
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <Cards> | |
| <Card title="Open source code repo for op stack builders" href="/builders/app-developers/tools/ecosystem-overview" /> | |
| <Card title="Supersim" href="/builders/app-developers/tools/supersim" /> | |
| </Cards> | |
| <Cards> | |
| <Card title="Open-Source Code Repository for OP Stack Builders" href="/builders/app-developers/tools/ecosystem-overview" /> | |
| <Card title="SuperSim" href="/builders/app-developers/tools/supersim" /> | |
| </Cards> |
| # Tools | ||
|
|
||
| This section provides information on open source code repo for op stack builders and supersim. You'll find reference to help you understand and work with these topics. |
There was a problem hiding this comment.
Improve the introductory text for clarity and consistency
Please update the introductory text to improve clarity, consistency, and adherence to the coding guidelines:
-# Tools
-
-This section provides information on open source code repo for op stack builders and supersim. You'll find reference to help you understand and work with these topics.
+# Tools
+
+This section provides information on open-source code repositories for OP Stack builders and SuperSim. Users will find references to help understand and work with these topics.These changes address the following:
- Use of proper nouns instead of "you'll".
- Correct capitalization for "OP Stack" and "SuperSim".
- Use of a hyphen for "open-source".
- Improved phrasing for clarity.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| # Tools | |
| This section provides information on open source code repo for op stack builders and supersim. You'll find reference to help you understand and work with these topics. | |
| # Tools | |
| This section provides information on open-source code repositories for OP Stack builders and SuperSim. Users will find references to help understand and work with these topics. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~10-~10: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...s This section provides information on open source code repo for op stack builders and sup...(EN_COMPOUND_ADJECTIVE_INTERNAL)
|
|
||
| # Testing | ||
|
|
||
| This section provides information on running a local development environment and testing apps for op mainnet. You'll find tutorial, guide to help you understand and work with these topics. |
There was a problem hiding this comment.
Improve grammar, clarity, and proper noun usage in the overview paragraph.
The overview paragraph requires several improvements:
- Use proper capitalization for "OP Mainnet".
- Fix plural forms and article usage.
- Improve sentence structure for clarity.
Please consider the following revision:
- This section provides information on running a local development environment and testing apps for op mainnet. You'll find tutorial, guide to help you understand and work with these topics.
+ This section provides information on running a local development environment and testing apps for OP Mainnet. You'll find tutorials and guides to help you understand and work with these topics.This revision addresses the grammatical issues, improves clarity, and ensures proper capitalization of "OP Mainnet".
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| This section provides information on running a local development environment and testing apps for op mainnet. You'll find tutorial, guide to help you understand and work with these topics. | |
| This section provides information on running a local development environment and testing apps for OP Mainnet. You'll find tutorials and guides to help you understand and work with these topics. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~10-~10: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...esting apps for op mainnet. You'll find tutorial, guide to help you understand and work ...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~10-~10: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...s for op mainnet. You'll find tutorial, guide to help you understand and work with th...(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
| <Cards> | ||
| <Card title="Bridging erc 20 tokens to op mainnet with the optimism sdk" href="/builders/app-developers/tutorials/cross-dom-bridge-erc20" /> | ||
|
|
||
| <Card title="Bridging eth to op mainnet with the optimism sdk" href="/builders/app-developers/tutorials/cross-dom-bridge-eth" /> | ||
|
|
||
| <Card title="Communicating between op mainnet and ethereum in solidity" href="/builders/app-developers/tutorials/cross-dom-solidity" /> | ||
|
|
||
| <Card title="Deploying your first contract on op mainnet" href="/builders/app-developers/tutorials/first-contract" /> | ||
|
|
||
| <Card title="Estimating transaction costs on op mainnet" href="/builders/app-developers/tutorials/sdk-estimate-costs" /> | ||
|
|
||
| <Card title="Tracing deposits and withdrawals" href="/builders/app-developers/tutorials/sdk-trace-txns" /> | ||
|
|
||
| <Card title="Viewing deposits and withdrawals by address" href="/builders/app-developers/tutorials/sdk-view-txns" /> | ||
|
|
||
| <Card title="Triggering op mainnet transactions from ethereum" href="/builders/app-developers/tutorials/send-tx-from-eth" /> | ||
|
|
||
| <Card title="Bridging your custom erc 20 token using the standard bridge" href="/builders/app-developers/tutorials/standard-bridge-custom-token" /> | ||
|
|
||
| <Card title="Bridging your standard erc 20 token using the standard bridge" href="/builders/app-developers/tutorials/standard-bridge-standard-token" /> | ||
| </Cards> |
There was a problem hiding this comment.
Improve Card titles for consistency and adherence to guidelines
The Card components need improvements in their titles:
- Use title case for all titles as per the coding guidelines.
- Use full forms instead of abbreviations (e.g., "ERC-20" instead of "erc 20").
- Replace "op mainnet" with "OP Stack" as mentioned in the PR objectives.
- Ensure consistency in terminology and capitalization across all titles.
Here's a suggested revision for all Card titles:
<Cards>
<Card title="Bridging ERC-20 Tokens to OP Stack with the Optimism SDK" href="/builders/app-developers/tutorials/cross-dom-bridge-erc20" />
<Card title="Bridging ETH to OP Stack with the Optimism SDK" href="/builders/app-developers/tutorials/cross-dom-bridge-eth" />
<Card title="Communicating Between OP Stack and Ethereum in Solidity" href="/builders/app-developers/tutorials/cross-dom-solidity" />
<Card title="Deploying Your First Contract on OP Stack" href="/builders/app-developers/tutorials/first-contract" />
<Card title="Estimating Transaction Costs on OP Stack" href="/builders/app-developers/tutorials/sdk-estimate-costs" />
<Card title="Tracing Deposits and Withdrawals" href="/builders/app-developers/tutorials/sdk-trace-txns" />
<Card title="Viewing Deposits and Withdrawals by Address" href="/builders/app-developers/tutorials/sdk-view-txns" />
<Card title="Triggering OP Stack Transactions from Ethereum" href="/builders/app-developers/tutorials/send-tx-from-eth" />
<Card title="Bridging Your Custom ERC-20 Token Using the Standard Bridge" href="/builders/app-developers/tutorials/standard-bridge-custom-token" />
<Card title="Bridging Your Standard ERC-20 Token Using the Standard Bridge" href="/builders/app-developers/tutorials/standard-bridge-standard-token" />
</Cards>These changes improve consistency, clarity, and adherence to the coding guidelines and PR objectives.
| --- | ||
| title: Tutorials | ||
| lang: en-US | ||
| --- | ||
|
|
||
| import { Card, Cards } from 'nextra/components' | ||
|
|
There was a problem hiding this comment.
Add a description to the frontmatter
The frontmatter is missing a required 'description' property. This property is important for SEO and providing a summary of the page content.
Please add a description to the frontmatter. For example:
---
title: Tutorials
lang: en-US
+description: A collection of tutorials for app developers building on OP Stack, covering topics such as bridging tokens, deploying contracts, and estimating transaction costs.
---📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| --- | |
| title: Tutorials | |
| lang: en-US | |
| --- | |
| import { Card, Cards } from 'nextra/components' | |
| --- | |
| title: Tutorials | |
| lang: en-US | |
| description: A collection of tutorials for app developers building on OP Stack, covering topics such as bridging tokens, deploying contracts, and estimating transaction costs. | |
| --- | |
| import { Card, Cards } from 'nextra/components' |
🧰 Tools
🪛 GitHub Check: lint
[warning] 1-1:
Must have required property 'description' • /home/runner/work/docs/docs/utils/schemas/page.schema.yaml • #/required
| function generateOverview(fileInfos: FileInfo[]): string { | ||
| const topics = fileInfos.map(file => file.title.toLowerCase()); | ||
| const uniqueTopics = uniqueArray(topics); | ||
|
|
||
| let overview = `This section provides information on ${uniqueTopics.slice(0, -1).join(', ')}`; | ||
| if (uniqueTopics.length > 1) { | ||
| overview += ` and ${uniqueTopics[uniqueTopics.length - 1]}`; | ||
| } | ||
| overview += '. '; | ||
|
|
||
| const keywordRegex = /\b(guide|tutorial|overview|introduction|tool|concept|api|reference)\b/i; | ||
| const keywords = uniqueArray( | ||
| fileInfos.flatMap(file => { | ||
| const matches = file.content.match(keywordRegex); | ||
| return matches ? matches.map(keyword => keyword.toLowerCase()) : []; | ||
| }) | ||
| ); | ||
|
|
||
| if (keywords.length > 0) { | ||
| overview += `You'll find ${keywords.join(', ')} to help you understand and work with these topics.`; | ||
| } | ||
|
|
||
| return overview; | ||
| } |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Consider using Set for unique topics.
The generateOverview function could be more efficient by using a Set for unique topics instead of calling uniqueArray. This would reduce the time complexity from O(n^2) to O(n).
Consider refactoring the unique topics logic as follows:
const topics = new Set(fileInfos.map(file => file.title.toLowerCase()));
const uniqueTopics = Array.from(topics);This change will improve the efficiency of the function, especially for larger datasets.
| const createMdxFile = async (parentFolderPath: string, folderName: string): Promise<void> => { | ||
| const folderPath = path.join(parentFolderPath, folderName); | ||
| const files = await fs.readdir(folderPath); | ||
| const mdFiles = files.filter(file => | ||
| (file.endsWith('.md') || file.endsWith('.mdx')) && | ||
| !file.startsWith('_') | ||
| ); | ||
|
|
||
| const title = toTitleCase(folderName); | ||
|
|
||
| const fileInfos: FileInfo[] = []; | ||
|
|
||
| for (const file of mdFiles) { | ||
| const filePath = path.join(folderPath, file); | ||
| const fileContent = await fs.readFile(filePath, 'utf-8'); | ||
| let fileTitle = fileContent.match(/^#\s+(.+)/m)?.[1] || path.basename(file, path.extname(file)); | ||
| fileTitle = toTitleCase(fileTitle); | ||
| const relativeUrl = `/${path.relative(rootDir, folderPath)}/${path.basename(file, path.extname(file))}`.replace(/\\/g, '/'); | ||
|
|
||
| if (!fileInfos.some(info => info.url === relativeUrl)) { | ||
| fileInfos.push({ title: fileTitle, url: relativeUrl, content: fileContent }); | ||
| } | ||
| } | ||
|
|
||
| const overview = generateOverview(fileInfos); | ||
|
|
||
| let content = `--- | ||
| title: ${title} | ||
| lang: en-US | ||
| --- | ||
|
|
||
| import { Card, Cards } from 'nextra/components' | ||
|
|
||
| # ${title} | ||
|
|
||
| ${overview} | ||
|
|
||
| <Cards> | ||
| `; | ||
|
|
||
| fileInfos.forEach(({ title, url }) => { | ||
| content += ` <Card title="${title}" href="${url}" />\n`; | ||
| }); | ||
|
|
||
| content += '</Cards>'; | ||
|
|
||
| const mdxFileName = `${folderName}.mdx`; | ||
| const mdxFilePath = path.join(parentFolderPath, mdxFileName); | ||
|
|
||
| // Check if the file already exists and has the same content | ||
| try { | ||
| const existingContent = await fs.readFile(mdxFilePath, 'utf-8'); | ||
| if (existingContent.trim() === content.trim()) { | ||
| console.log(`${mdxFileName} in ${parentFolderPath} is up to date. Skipping.`); | ||
| return; | ||
| } | ||
| } catch (error) { | ||
| } | ||
|
|
||
| await fs.writeFile(mdxFilePath, content); | ||
| console.log(`Created/Updated ${mdxFileName} in ${parentFolderPath}`); | ||
| }; |
There was a problem hiding this comment.
Enhance error handling in createMdxFile function.
While the function is well-structured, it could benefit from improved error handling, especially for file read/write operations.
Consider wrapping the file operations in try-catch blocks to handle potential errors gracefully. For example:
try {
await fs.writeFile(mdxFilePath, content);
console.log(`Created/Updated ${mdxFileName} in ${parentFolderPath}`);
} catch (error) {
console.error(`Error writing file ${mdxFilePath}:`, error);
}This will provide better visibility into any issues that may occur during file operations.
| const processFolder = async (folderPath: string): Promise<void> => { | ||
| try { | ||
| const files = await fs.readdir(folderPath); | ||
|
|
||
| for (const file of files) { | ||
| const filePath = path.join(folderPath, file); | ||
| const stats = await fs.stat(filePath); | ||
|
|
||
| if (stats.isDirectory()) { | ||
| await createMdxFile(folderPath, file); | ||
| await processFolder(filePath); | ||
| } | ||
| } | ||
| } catch (error) { | ||
| console.error(`Error processing folder ${folderPath}:`, error); | ||
| } | ||
| }; | ||
|
|
||
| const main = async (): Promise<void> => { | ||
| for (const folder of targetFolders) { | ||
| const folderPath = path.join(rootDir, folder); | ||
| await processFolder(folderPath); | ||
| } | ||
| }; | ||
|
|
||
| main().catch(console.error); | ||
|
|
||
| console.log('Root directory:', rootDir); |
There was a problem hiding this comment.
Enhance error handling in main function.
While the processFolder function includes error handling, the main function could benefit from more robust error management.
Consider wrapping the entire execution of main in a try-catch block to handle any unexpected errors:
const main = async (): Promise<void> => {
try {
for (const folder of targetFolders) {
const folderPath = path.join(rootDir, folder);
await processFolder(folderPath);
}
console.log('Breadcrumb creation completed successfully.');
} catch (error) {
console.error('An error occurred during breadcrumb creation:', error);
}
};
main();This will ensure that any errors during the execution are caught and logged, providing better visibility into potential issues.
Description
This PR introduces a script that automates the creation and updating of .mdx files to improve the breadcrumb navigation on desktop and mobile.
Key Features:
Tests
Additional context
Metadata