SubQuery Featured #2917
SubQuery Featured #2917
Conversation
WalkthroughThe new documentation introduces the SubQuery Indexer, a powerful blockchain data indexer supporting 150+ ecosystems. It highlights its fast, flexible, and decentralized APIs for web3 projects, enabling feature-rich analytics and multi-chain projects. Changes
Recent Review DetailsConfiguration used: CodeRabbit UI Files selected for processing (1)
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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 7
Configuration used: CodeRabbit UI
Files selected for processing (1)
- docs/tools/subquery.md (1 hunks)
Additional comments: 1
docs/tools/subquery.md (1)
- 1-25: Ensure consistency in the use of British vs. American English throughout the document based on the target audience's preference. Additionally, verify the accessibility of all external links to ensure they are correct and functional.
Verification successful
The verification process for the external links mentioned in the document has been successfully completed. All provided links are accessible and return a 200 HTTP status code, indicating they are correct and functional.
Regarding the consistency in the use of British vs. American English, this aspect was not verifiable through script execution and would require manual review. However, the primary concern of link accessibility has been addressed.
Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Example command to check the status of external links in the markdown file. # Note: Actual implementation depends on available tools and may require a custom script. curl -o /dev/null --silent --head --write-out '%{http_code}' [URL] | grep 200Length of output: 81
Script:
#!/bin/bash # Verifying the accessibility of external links mentioned in the document. # SubQuery Academy (Documentation) curl -o /dev/null --silent --head --write-out '%{http_code}\n' https://academy.subquery.network/ | grep 200 # Intro Quick Start Guide: 1. Create a New Project curl -o /dev/null --silent --head --write-out '%{http_code}\n' https://academy.subquery.network/quickstart/quickstart.html | grep 200 # Starter Project curl -o /dev/null --silent --head --write-out '%{http_code}\n' https://github.com/subquery/cosmos-subql-starter/tree/main/Iris/iris-starter | grep 200 # Instructions on how to run SubQuery Locally curl -o /dev/null --silent --head --write-out '%{http_code}\n' https://academy.subquery.network/run_publish/run.html | grep 200 # Managed Service curl -o /dev/null --silent --head --write-out '%{http_code}\n' https://managedservice.subquery.network/ | grep 200 # SubQuery Network curl -o /dev/null --silent --head --write-out '%{http_code}\n' https://subquery.network/network | grep 200Length of output: 778
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
docs/tools/subquery.md
Outdated
|
|
||
| SubQuery is a leading blockchain data indexer that provides developers with fast, flexible, universal, open-source and decentralised APIs for web3 projects. SubQuery SDK allows developers to get rich indexed data and build intuitive and immersive decentralised applications in a faster and more efficient way. SubQuery supports 150+ ecosystems including Iris, Cosmos, Ethereum, Near, Polygon, Polkadot, Algorand, and Avalanche. | ||
|
|
||
| Another one of SubQuery's competitive advantages is the ability to aggregate data not only within a chain but across multiple blockchains all within a single project. This allows the creation of feature-rich dashboard analytics, multi-chain block scanners, or projects that index IBC transactions across zones. |
There was a problem hiding this comment.
Consider adding a comma after "blockchains" for better readability and changing "multi-chain" to "multichain" for consistency with industry terminology.
- across multiple blockchains all within a single project
+ across multiple blockchains, all within a single project
- multi-chain block scanners
+ multichain block scannersCommittable 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.
| Another one of SubQuery's competitive advantages is the ability to aggregate data not only within a chain but across multiple blockchains all within a single project. This allows the creation of feature-rich dashboard analytics, multi-chain block scanners, or projects that index IBC transactions across zones. | |
| Another one of SubQuery's competitive advantages is the ability to aggregate data not only within a chain but across multiple blockchains, all within a single project. This allows the creation of feature-rich dashboard analytics, multichain block scanners, or projects that index IBC transactions across zones. |
docs/tools/subquery.md
Outdated
| SubQuery is open-source, meaning you have the freedom to run it in the following three ways: | ||
|
|
||
| - Locally on your own computer (or a cloud provider of your choosing), [view the instructions on how to run SubQuery Locally](https://academy.subquery.network/run_publish/run.html). | ||
| - You can publish it to SubQuery's enterprise-level [Managed Service](https://managedservice.subquery.network/), where we'll host your SubQuery project in production ready services for mission critical data with zero-downtime blue/green deployments. There even is a generous free tier. [Find out how](https://academy.subquery.network/run_publish/publish.html). |
There was a problem hiding this comment.
Consider using "production-ready" as a hyphenated compound adjective to modify "services" and "mission-critical" with a hyphen when used as a compound adjective.
- production ready services
+ production-ready services
- mission critical data
+ mission-critical dataCommittable 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.
| - You can publish it to SubQuery's enterprise-level [Managed Service](https://managedservice.subquery.network/), where we'll host your SubQuery project in production ready services for mission critical data with zero-downtime blue/green deployments. There even is a generous free tier. [Find out how](https://academy.subquery.network/run_publish/publish.html). | |
| - You can publish it to SubQuery's enterprise-level [Managed Service](https://managedservice.subquery.network/), where we'll host your SubQuery project in production-ready services for mission-critical data with zero-downtime blue/green deployments. There even is a generous free tier. [Find out how](https://academy.subquery.network/run_publish/publish.html). |
docs/tools/subquery.md
Outdated
|
|
||
| - Locally on your own computer (or a cloud provider of your choosing), [view the instructions on how to run SubQuery Locally](https://academy.subquery.network/run_publish/run.html). | ||
| - You can publish it to SubQuery's enterprise-level [Managed Service](https://managedservice.subquery.network/), where we'll host your SubQuery project in production ready services for mission critical data with zero-downtime blue/green deployments. There even is a generous free tier. [Find out how](https://academy.subquery.network/run_publish/publish.html). | ||
| - You can publish it to the decentralised [SubQuery Network](https://subquery.network/network), the most open, performant, reliable, and scalable data service for dApp developers. The SubQuery Network indexes and services data to the global community in an incentivised and verifiable way and supports Iris from launch. |
There was a problem hiding this comment.
The document uses British English spelling for "decentralised" and "incentivised". Ensure consistency in spelling conventions throughout the document. If the target audience primarily uses American English, consider changing to "decentralized" and "incentivized".
- decentralised
+ decentralized
- incentivised
+ incentivizedCommittable 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.
| - You can publish it to the decentralised [SubQuery Network](https://subquery.network/network), the most open, performant, reliable, and scalable data service for dApp developers. The SubQuery Network indexes and services data to the global community in an incentivised and verifiable way and supports Iris from launch. | |
| - You can publish it to the decentralized [SubQuery Network](https://subquery.network/network), the most open, performant, reliable, and scalable data service for dApp developers. The SubQuery Network indexes and services data to the global community in an incentivized and verifiable way and supports Iris from launch. |
docs/tools/subquery.md
Outdated
| SubQuery is open-source, meaning you have the freedom to run it in the following three ways: | ||
|
|
||
| - Locally on your own computer (or a cloud provider of your choosing), [view the instructions on how to run SubQuery Locally](https://academy.subquery.network/run_publish/run.html). | ||
| - You can publish it to SubQuery's enterprise-level [Managed Service](https://managedservice.subquery.network/), where we'll host your SubQuery project in production ready services for mission critical data with zero-downtime blue/green deployments. There even is a generous free tier. [Find out how](https://academy.subquery.network/run_publish/publish.html). |
There was a problem hiding this comment.
The phrases "production ready" and "mission critical" are often hyphenated when used as compound adjectives. Consider adding hyphens to improve readability.
- production ready services for mission critical data
+ production-ready services for mission-critical dataCommittable 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.
| - You can publish it to SubQuery's enterprise-level [Managed Service](https://managedservice.subquery.network/), where we'll host your SubQuery project in production ready services for mission critical data with zero-downtime blue/green deployments. There even is a generous free tier. [Find out how](https://academy.subquery.network/run_publish/publish.html). | |
| - You can publish it to SubQuery's enterprise-level [Managed Service](https://managedservice.subquery.network/), where we'll host your SubQuery project in production-ready services for mission-critical data with zero-downtime blue/green deployments. There even is a generous free tier. [Find out how](https://academy.subquery.network/run_publish/publish.html). |
docs/tools/subquery.md
Outdated
|
|
||
| - Locally on your own computer (or a cloud provider of your choosing), [view the instructions on how to run SubQuery Locally](https://academy.subquery.network/run_publish/run.html). | ||
| - You can publish it to SubQuery's enterprise-level [Managed Service](https://managedservice.subquery.network/), where we'll host your SubQuery project in production ready services for mission critical data with zero-downtime blue/green deployments. There even is a generous free tier. [Find out how](https://academy.subquery.network/run_publish/publish.html). | ||
| - You can publish it to the decentralised [SubQuery Network](https://subquery.network/network), the most open, performant, reliable, and scalable data service for dApp developers. The SubQuery Network indexes and services data to the global community in an incentivised and verifiable way and supports Iris from launch. |
There was a problem hiding this comment.
The document uses British English spelling for "decentralised" and "incentivised". If the target audience primarily uses American English, consider changing to "decentralized" and "incentivized".
- decentralised
+ decentralized
- incentivised
+ incentivizedCommittable 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.
| - You can publish it to the decentralised [SubQuery Network](https://subquery.network/network), the most open, performant, reliable, and scalable data service for dApp developers. The SubQuery Network indexes and services data to the global community in an incentivised and verifiable way and supports Iris from launch. | |
| - You can publish it to the decentralized [SubQuery Network](https://subquery.network/network), the most open, performant, reliable, and scalable data service for dApp developers. The SubQuery Network indexes and services data to the global community in an incentivized and verifiable way and supports Iris from launch. |
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
docs/tools/subquery.md
Outdated
|
|
||
| SubQuery is a leading blockchain data indexer that provides developers with fast, flexible, universal, open-source and decentralized APIs for web3 projects. SubQuery SDK allows developers to get rich indexed data and build intuitive and immersive decentralized applications in a faster and more efficient way. SubQuery supports 150+ ecosystems including Iris, Cosmos, Ethereum, Near, Polygon, Polkadot, Algorand, and Avalanche. | ||
|
|
||
| Another one of SubQuery's competitive advantages is the ability to aggregate data not only within a chain but across multiple blockchains, all within a single project. This allows the creation of feature-rich dashboard analytics, multi-chain block scanners, or projects that index IBC transactions across zones. |
There was a problem hiding this comment.
The term "multi-chain" should be hyphenated when used as an adjective for consistency with industry terminology.
- multi-chain block scanners
+ multichain block scannersCommittable 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.
| Another one of SubQuery's competitive advantages is the ability to aggregate data not only within a chain but across multiple blockchains, all within a single project. This allows the creation of feature-rich dashboard analytics, multi-chain block scanners, or projects that index IBC transactions across zones. | |
| Another one of SubQuery's competitive advantages is the ability to aggregate data not only within a chain but across multiple blockchains, all within a single project. This allows the creation of feature-rich dashboard analytics, multichain block scanners, or projects that index IBC transactions across zones. |
|
|
||
| # SubQuery Indexer | ||
|
|
||
| SubQuery is a leading blockchain data indexer that provides developers with fast, flexible, universal, open-source and decentralized APIs for web3 projects. SubQuery SDK allows developers to get rich indexed data and build intuitive and immersive decentralized applications in a faster and more efficient way. SubQuery supports 150+ ecosystems including Iris, Cosmos, Ethereum, Near, Polygon, Polkadot, Algorand, and Avalanche. |
There was a problem hiding this comment.
Use "open-source" consistently as a compound adjective.
- open source and decentralized APIs
+ open-source and decentralized APIsCommittable 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.
| SubQuery is a leading blockchain data indexer that provides developers with fast, flexible, universal, open-source and decentralized APIs for web3 projects. SubQuery SDK allows developers to get rich indexed data and build intuitive and immersive decentralized applications in a faster and more efficient way. SubQuery supports 150+ ecosystems including Iris, Cosmos, Ethereum, Near, Polygon, Polkadot, Algorand, and Avalanche. | |
| SubQuery is a leading blockchain data indexer that provides developers with fast, flexible, universal, open-source and decentralized APIs for web3 projects. SubQuery SDK allows developers to get rich indexed data and build intuitive and immersive decentralized applications in a faster and more efficient way. SubQuery supports 150+ ecosystems including Iris, Cosmos, Ethereum, Near, Polygon, Polkadot, Algorand, and Avalanche. |
|
|
||
| SubQuery is a leading blockchain data indexer that provides developers with fast, flexible, universal, open-source and decentralized APIs for web3 projects. SubQuery SDK allows developers to get rich indexed data and build intuitive and immersive decentralized applications in a faster and more efficient way. SubQuery supports 150+ ecosystems including Iris, Cosmos, Ethereum, Near, Polygon, Polkadot, Algorand, and Avalanche. | ||
|
|
||
| Another one of SubQuery's competitive advantages is the ability to aggregate data not only within a chain but across multiple blockchains, all within a single project. This allows the creation of feature-rich dashboard analytics, multichain block scanners, or projects that index IBC transactions across zones. |
There was a problem hiding this comment.
Add a comma for better readability and use "multichain" consistently.
- across multiple blockchains all within a single project
+ across multiple blockchains, all within a single project
- multichain block scanners
+ multichain block scannersCommittable 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.
| Another one of SubQuery's competitive advantages is the ability to aggregate data not only within a chain but across multiple blockchains, all within a single project. This allows the creation of feature-rich dashboard analytics, multichain block scanners, or projects that index IBC transactions across zones. | |
| Another one of SubQuery's competitive advantages is the ability to aggregate data not only within a chain but across multiple blockchains, all within a single project. This allows the creation of feature-rich dashboard analytics, multichain block scanners, or projects that index IBC transactions across zones. |
| - Intro Quick Start Guide: [1. Create a New Project](https://academy.subquery.network/quickstart/quickstart.html) | ||
| - [Starter Project](https://github.com/subquery/cosmos-subql-starter/tree/main/Iris/iris-starter) | ||
|
|
||
| For technical questions and support, reach out to us `[email protected]` |
There was a problem hiding this comment.
Add a comma after "support" for better readability.
- For technical questions and support reach out to us `[email protected]`
+ For technical questions and support, reach out to us `[email protected]`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.
| For technical questions and support, reach out to us `[email protected]` | |
| For technical questions and support, reach out to us `[email protected]` |
| SubQuery is open-source, meaning you have the freedom to run it in the following three ways: | ||
|
|
||
| - Locally on your own computer (or a cloud provider of your choosing), [view the instructions on how to run SubQuery Locally](https://academy.subquery.network/run_publish/run.html). | ||
| - You can publish it to SubQuery's enterprise-level [Managed Service](https://managedservice.subquery.network/), where we'll host your SubQuery project in production-ready services for mission-critical data with zero-downtime blue/green deployments. There even is a generous free tier. [Find out how](https://academy.subquery.network/run_publish/publish.html). |
There was a problem hiding this comment.
Use hyphenated compound adjectives for "production-ready" and "mission-critical".
- production ready services for mission critical data
+ production-ready services for mission-critical dataCommittable 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.
| - You can publish it to SubQuery's enterprise-level [Managed Service](https://managedservice.subquery.network/), where we'll host your SubQuery project in production-ready services for mission-critical data with zero-downtime blue/green deployments. There even is a generous free tier. [Find out how](https://academy.subquery.network/run_publish/publish.html). | |
| - You can publish it to SubQuery's enterprise-level [Managed Service](https://managedservice.subquery.network/), where we'll host your SubQuery project in production-ready services for mission-critical data with zero-downtime blue/green deployments. There even is a generous free tier. [Find out how](https://academy.subquery.network/run_publish/publish.html). |
Hello Iris team,
We are submitting this contribution with the intention of incorporating SubQuery into your project documentation. As you can observe, we have already prepared the initial project. Kindly inform us if any adjustments are necessary on our part.
Summary by CodeRabbit