Add Ormi Subgraph Hosting Guide #472
Conversation
WalkthroughThe changes introduce a comprehensive guide for utilizing Ormi's 0xgraph subgraph hosting solution, specifically designed for Rollkit rollups. It includes prerequisites such as Node.js and familiarity with Subgraphs and GraphQL APIs. The guide covers the installation of the 0xgraph CLI tool, API key authentication, and detailed steps for creating and deploying a subgraph, including project structure preparation and deployment to Ormi's service. Additional resources are provided for further exploration. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant CLI
participant OrmiService
User->>CLI: Install 0xgraph CLI tool
User->>CLI: Authenticate with API key
User->>CLI: Create subgraph project
CLI->>CLI: Generate types and mappings
CLI->>CLI: Build subgraph
User->>CLI: Register subgraph
CLI->>OrmiService: Deploy subgraph
OrmiService-->>CLI: Confirm deployment
CLI-->>User: Deployment successful
Poem
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
CodeRabbit Configuration File (
|
![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 (4)
guides/ormi-subgraph-hosting.md (4)
7-7: Consider making the email address clickable for better user experience.The email address provided for contacting the Ormi team could be formatted as a clickable link to make it easier for users to reach out.
You can update the line as follows:
Please note that network support for your specific rollup will need to be added before subgraphs can be fully migrated. To get network support added for your rollup, please reach out to the Ormi team at [julian@ormi.xyz](mailto:julian@ormi.xyz).🧰 Tools
🪛 Markdownlint
7-7: null
Bare URL used(MD034, no-bare-urls)
13-14: Consider adding resource links for Subgraphs and GraphQL APIs.To assist users who may not be familiar with Subgraphs or GraphQL APIs, it would be helpful to provide links to introductory resources.
You could update the lines as follows:
- Node.js installed on your system - Basic understanding of [Subgraphs](https://thegraph.com/docs/en/about/introduction/) and [GraphQL APIs](https://graphql.org/learn/)
30-30: Format the URL as a clickable link.To improve readability and follow Markdown best practices, the bare URL should be formatted as a clickable link.
Update the line as follows:
When prompted, enter your deploy key. You can obtain this key by signing up at [https://app.0xgraph.xyz/dashboard/api](https://app.0xgraph.xyz/dashboard/api).🧰 Tools
🪛 LanguageTool
[grammar] ~30-~30: The word ‘deploy’ is a verb. Did you mean the noun “deployment” (= release, placement)?
Context: ...raph auth ``` When prompted, enter your deploy key. You can obtain this key by signing...(PREPOSITION_VERB)
🪛 Markdownlint
30-30: null
Bare URL used(MD034, no-bare-urls)
69-69: Consider adding specific links to the mentioned resources.To make it easier for users to access additional information, consider adding direct links to The Graph's official documentation and the Messari subgraphs repository.
You could update the paragraph as follows:
For more detailed information on subgraph development and best practices, refer to [The Graph's official documentation](https://thegraph.com/docs/) and the [Messari subgraphs repository](https://github.com/messari/subgraphs). Stay tuned for updates as Ormi continues to expand its network support and feature set, bringing advanced data solutions to an ever-growing number of blockchain ecosystems.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- guides/ormi-subgraph-hosting.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
guides/ormi-subgraph-hosting.md
[grammar] ~30-~30: The word ‘deploy’ is a verb. Did you mean the noun “deployment” (= release, placement)?
Context: ...raph auth ``` When prompted, enter your deploy key. You can obtain this key by signing...(PREPOSITION_VERB)
🪛 Markdownlint
guides/ormi-subgraph-hosting.md
7-7: null
Bare URL used(MD034, no-bare-urls)
30-30: null
Bare URL used(MD034, no-bare-urls)
🔇 Additional comments (2)
guides/ormi-subgraph-hosting.md (2)
32-60: LGTM! Clear and well-structured instructions.The step-by-step guide for creating and deploying a subgraph is clear, concise, and easy to follow. The use of code blocks for commands enhances readability.
71-71: LGTM! Useful and well-formatted links provided.The links section provides relevant resources for users to find more information about Ormi Labs and their services. The formatting is clear and consistent.
|
@tuxcanfly @tzdybal @gupadhyaya I am getting the following error in my PR: Is there any way to resolve this error, so that we can merge this PR? For context: I am from Ormi Labs and we are looking to add a guide for our Subgraph hosting solution to the guide folder. Manav is the person on the team we are in contact with and he told us to do this PR to get our docs merged. |
|
@MSevey Think the previews action is missing permissions for external contributors: |
@tuxcanfly this is a github security measure. External contributors can't run |
Don' worry about it. The only required CI for external contributors is the |
Co-authored-by: Matthew Sevey <15232757+MSevey@users.noreply.github.com>
Co-authored-by: Matthew Sevey <15232757+MSevey@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (4)
guides/ormi-subgraph-hosting.md (4)
7-7: Consider using a contact form instead of direct email.To prevent potential spam and improve maintainability, consider replacing the direct email address with a link to a contact form or documentation page that explains the process of requesting network support.
-To get network support added for your rollup, please reach out to the Ormi team at julian@ormi.xyz. +To get network support added for your rollup, please reach out to the Ormi team through our [contact form](https://ormi.xyz/contact).🧰 Tools
🪛 Markdownlint
7-7: null
Bare URL used(MD034, no-bare-urls)
25-25: Format the URL as a proper Markdown link.Convert the bare URL to a proper Markdown link for better formatting and accessibility.
-Next you'll need to authenticate with Ormi using your API key. You can obtain this key by signing up at https://app.0xgraph.xyz/dashboard/api. +Next you'll need to authenticate with Ormi using your API key. You can obtain this key by signing up at [Ormi's API Dashboard](https://app.0xgraph.xyz/dashboard/api).🧰 Tools
🪛 Markdownlint
25-25: null
Bare URL used(MD034, no-bare-urls)
41-43: Enhance command descriptions with expected output.The deployment commands would benefit from additional context about their expected output and potential error scenarios. This helps users verify they're on the right track.
Consider adding example output and common troubleshooting tips for each command. For example:
Run the following command in your Subgraph project root: ```bash 0xgraph codegen+You should see output indicating that types were generated successfully. If you encounter any errors, ensure your schema.graphql file is properly formatted.
Also applies to: 46-48, 50-53, 55-58 --- `71-71`: **Enhance resource links with descriptions.** The resource links would be more useful with brief descriptions of what users can expect to find at each link. ```diff -Links: [Ormi Labs](https://ormi.xyz/) | [0xgraph docs](https://docs.ormi.xyz/0xgraph) | [X](https://x.com/ormilabs) +## Additional Resources + +- [Ormi Labs Homepage](https://ormi.xyz/) - Learn more about Ormi's products and services +- [0xgraph Documentation](https://docs.ormi.xyz/0xgraph) - Detailed technical documentation and API reference +- [Follow Ormi on X](https://x.com/ormilabs) - Stay updated with the latest announcements and features
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
guides/ormi-subgraph-hosting.md(1 hunks)
🧰 Additional context used
🪛 Markdownlint
guides/ormi-subgraph-hosting.md
7-7: null
Bare URL used
(MD034, no-bare-urls)
25-25: null
Bare URL used
(MD034, no-bare-urls)
|
|
||
| ```bash | ||
| 0xgraph auth | ||
|
|
There was a problem hiding this comment.
Add missing code block closure.
The code block starting at line 29 is missing its closing backticks.
0xgraph auth
+```📝 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.
| 0xgraph auth |
Adding Ormi Subgraph hosting guide for rollkit rollups.
Summary by CodeRabbit