Added new page for Data Indexers under pages/builders/tools/monitor #1148
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe changes in this pull request involve the addition of a new card titled "Data Indexers" to the existing Possibly related PRs
Suggested reviewers
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (8)
pages/builders/tools/monitor.mdx (4)
Line range hint
1-7: Enhance the description metadata for clarity and specificityThe current description is repetitive and vague. Consider revising it to be more specific about the monitoring capabilities and tools covered in this section.
description: >- - Learn about monitor in the Optimism ecosystem. This guide provides detailed - information and resources about monitor. + Learn about monitoring tools and analytics in the Optimism ecosystem. This guide provides + detailed information about blockchain analytics, historical data access, and data indexing.
Line range hint
11-12: Fix grammar and capitalization in the introductionThe introductory text contains grammar issues and improper capitalization of proper nouns.
- 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.
Line range hint
14-16: Standardize card titles and fix hyphenationThe card titles need consistent capitalization and proper hyphenation.
- <Card title="Analytics tools" href="/builders/tools/monitor/analytics-tools" /> - <Card title="Accessing pre Regenesis history" href="/builders/tools/monitor/regenesis-history" /> + <Card title="Analytics Tools" href="/builders/tools/monitor/analytics-tools" /> + <Card title="Accessing Pre-Regenesis History" href="/builders/tools/monitor/regenesis-history" />
19-20: Remove extra newline and standardize new card titleThere's an unnecessary blank line before the new card, and its title should follow the same capitalization pattern.
- - <Card title="Data Indexers" href="/builders/tools/monitor/data-indexers" /> + <Card title="Data Indexers" href="/builders/tools/monitor/data-indexers" />pages/builders/tools/monitor/data-indexers.mdx (4)
7-10: Maintain consistent capitalization and avoid personal pronouns.For better consistency:
- Standardize "dApp" vs "dapp" usage throughout the document
- Replace "your dApp" with "an application" to maintain neutral tone
-Data indexing is essential for enabling your dApp to efficiently read blockchain data. +Data indexing is essential for enabling applications to efficiently read blockchain data.
11-12: Remove personal pronoun for consistency.-Below is a list of indexing providers that can help you index data for your smart contract on Optimism. +Below is a list of indexing providers that can help index data for smart contracts on Optimism.
21-23: Avoid using italics for emphasis in bullet points.Per the style guidelines, avoid using italics for emphasis. The bullet points should be formatted as regular text.
-* Decentralized Indexing: Improves redundancy and query speed. Lets you eliminate any single point of failure. -* GraphQL Queries: Provides a powerful GraphQL interface for querying indexed data, making data retrieval super simple. -* Customization: Define your own logic for transforming & storing blockchain data. Reuse subgraphs published by other developers on The Graph Network. +* Decentralized indexing: Improves redundancy and query speed. Lets you eliminate any single point of failure. +* GraphQL queries: Provides a powerful GraphQL interface for querying indexed data, making data retrieval super simple. +* Customization: Define your own logic for transforming and storing blockchain data. Reuse subgraphs published by other developers on The Graph Network.
32-34: Enhance the placeholder text for the SaaS Providers section.Consider adding more context about what kind of information will be added in this section.
## SaaS Providers -(Coming soon) +This section will provide information about Software as a Service (SaaS) providers that offer blockchain data indexing solutions. Content coming soon.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (3)
pages/builders/tools/monitor.mdx(1 hunks)pages/builders/tools/monitor/data-indexers.mdx(1 hunks)words.txt(7 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
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 buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- For H1, H2, and H3 headers:
- Use sentence case, capitalizing only the first word.
- Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
- Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
- Flag any headers that seem to inconsistently apply these rules for manual review.
- When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
"
pages/builders/tools/monitor/data-indexers.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 buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- For H1, H2, and H3 headers:
- Use sentence case, capitalizing only the first word.
- Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
- Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
- Flag any headers that seem to inconsistently apply these rules for manual review.
- When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
"
🔇 Additional comments (2)
pages/builders/tools/monitor/data-indexers.mdx (1)
1-5: LGTM! Frontmatter is well-structured.
The metadata is properly formatted with clear title and description.
words.txt (1)
13-13: LGTM! The new terms are relevant additions.
The added terms are appropriate for blockchain documentation and properly maintain alphabetical sorting.
Also applies to: 151-151, 199-199, 294-295, 328-329, 372-372, 400-400
Description
This adds a new page for "data indexers" under pages/builders/tools/monitor.
It includes a short guide on The Graph.
Other providers can easily contribute to the same page.
Tests
Sucessfully ran the following:
Was able to run locally with
pnpm dev