Skip to content

Commit fecb7cd

Browse files
idalithbbenface
andauthored
Query-Intro (#848)
* adding structure * Graph Explorer-Reorg --------- Co-authored-by: Benoît Rouleau <[email protected]>
1 parent b77402c commit fecb7cd

File tree

2 files changed

+57
-27
lines changed

2 files changed

+57
-27
lines changed

website/pages/en/subgraphs/explorer.mdx

Lines changed: 40 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,19 @@
22
title: Graph Explorer
33
---
44

5-
Learn about The Graph Explorer and access the world of subgraphs and network data.
5+
Unlock the world of subgraphs and network data with [Graph Explorer](https://thegraph.com/explorer).
66

7-
Graph Explorer consists of multiple parts where you can interact with other subgraph developers, dapp developers, Curators, Indexers, and Delegators.
7+
## Overview
88

9-
## Video Guide
9+
Graph Explorer consists of multiple parts where you can interact with [subgraphs](https://thegraph.com/explorer?chain=arbitrum-one), [delegate](https://thegraph.com/explorer/delegate?chain=arbitrum-one), engage [participants](https://thegraph.com/explorer/participants?chain=arbitrum-one), view [network information](https://thegraph.com/explorer/network?chain=arbitrum-one), and access your user profile.
1010

11-
For a general overview of Graph Explorer, check out the video below:
11+
## Inside Explorer
1212

13-
<VideoEmbed youtube="u224xf7rEBY" />
13+
The following is a breakdown of all the key features of Graph Explorer. For additional support, you can watch the [Graph Explorer video guide](/subgraphs/explorer/#video-guide).
1414

15-
## Subgraphs
15+
### Subgraphs Page
1616

17-
After you just finish deploying and publishing your subgraph in Subgraph Studio, click on the "subgraphs tab” at the top of the navigation bar to access the following:
17+
After deploying and publishing your subgraph in Subgraph Studio, go to [Graph Explorer](https://thegraph.com/explorer) and click on the "[Subgraphs](https://thegraph.com/explorer?chain=arbitrum-one)" link in the navigation bar to access the following:
1818

1919
- Your own finished subgraphs
2020
- Subgraphs published by others
@@ -26,7 +26,8 @@ When you click into a subgraph, you will be able to do the following:
2626

2727
- Test queries in the playground and be able to leverage network details to make informed decisions.
2828
- Signal GRT on your own subgraph or the subgraphs of others to make indexers aware of its importance and quality.
29-
- This is critical because signaling on a subgraph incentivizes it to be indexed, meaning it’ll eventually surface on the network to serve queries.
29+
30+
- This is critical because signaling on a subgraph incentivizes it to be indexed, meaning it’ll eventually surface on the network to serve queries.
3031

3132
![Explorer Image 2](/img/Subgraph-Details.png)
3233

@@ -43,11 +44,22 @@ On each subgraph’s dedicated page, you can do the following:
4344

4445
![Explorer Image 3](/img/Explorer-Signal-Unsignal.png)
4546

46-
## Participants
47+
### Delegate Page
48+
49+
On the [Delegate page](https://thegraph.com/explorer/delegate?chain=arbitrum-one), you can find information about delegating, acquiring GRT, and choosing an Indexer.
50+
51+
On this page, you can see the following:
52+
53+
- Indexers who collected the most query fees
54+
- Indexers with the highest estimated APR
55+
56+
Additionally, you can calculate your ROI and search for top Indexers by name, address, or subgraph.
4757

48-
This section provides a bird' s-eye view of all "participants," which includes everyone participating in the network, such as Indexers, Delegators, and Curators.
58+
### Participants Page
4959

50-
### 1. Indexers
60+
This page provides a bird's-eye view of all "participants," which includes everyone participating in the network, such as Indexers, Delegators, and Curators.
61+
62+
#### 1. Indexers
5163

5264
![Explorer Image 4](/img/Indexer-Pane.png)
5365

@@ -76,7 +88,7 @@ To learn more about how to become an Indexer, you can take a look at the [offici
7688

7789
![Indexing details pane](/img/Indexing-Details-Pane.png)
7890

79-
### 2. Curators
91+
#### 2. Curators
8092

8193
Curators analyze subgraphs to identify which subgraphs are of the highest quality. Once a Curator has found a potentially high-quality subgraph, they can curate it by signaling on its bonding curve. In doing so, Curators let Indexers know which subgraphs are high quality and should be indexed.
8294

@@ -94,32 +106,32 @@ In the The Curator table listed below you can see:
94106

95107
If you want to learn more about the Curator role, you can do so by visiting [official documentation.](/resources/roles/curating/) or [The Graph Academy](https://thegraph.academy/curators/).
96108

97-
### 3. Delegators
109+
#### 3. Delegators
98110

99111
Delegators play a key role in maintaining the security and decentralization of The Graph Network. They participate in the network by delegating (i.e., “staking”) GRT tokens to one or multiple indexers.
100112

101113
- Without Delegators, Indexers are less likely to earn significant rewards and fees. Therefore, Indexers attract Delegators by offering them a portion of their indexing rewards and query fees.
102114
- Delegators select Indexers based on a number of different variables, such as past performance, indexing reward rates, and query fee cuts.
103-
- Reputation within the community can also play a factor in the selection process. Its recommended to connect with the selected Indexers via [The Graphs Discord](https://discord.gg/graphprotocol) or [The Graph Forum](https://forum.thegraph.com/)!
115+
- Reputation within the community can also play a factor in the selection process. It's recommended to connect with the selected Indexers via [The Graph's Discord](https://discord.gg/graphprotocol) or [The Graph Forum](https://forum.thegraph.com/).
104116

105117
![Explorer Image 7](/img/Delegation-Overview.png)
106118

107119
In the Delegators table you can see the active Delegators in the community and important metrics:
108120

109121
- The number of Indexers a Delegator is delegating towards
110-
- A Delegators original delegation
122+
- A Delegator's original delegation
111123
- The rewards they have accumulated but have not withdrawn from the protocol
112124
- The realized rewards they withdrew from the protocol
113125
- Total amount of GRT they have currently in the protocol
114126
- The date they last delegated
115127

116128
If you want to learn more about how to become a Delegator, check out the [official documentation](/resources/roles/delegating/) or [The Graph Academy](https://docs.thegraph.academy/official-docs/delegator/choosing-indexers).
117129

118-
## Network
130+
### Network Page
119131

120-
In this section, you can see global KPIs and view the ability to switch to a per-epoch basis and analyze network metrics in more detail. These details will give you a sense of how the network is performing over time.
132+
On this page, you can see global KPIs and have the ability to switch to a per-epoch basis and analyze network metrics in more detail. These details will give you a sense of how the network is performing over time.
121133

122-
### Overview
134+
#### Overview
123135

124136
The overview section has both all the current network metrics and some cumulative metrics over time:
125137

@@ -137,7 +149,7 @@ A few key details to note:
137149

138150
![Explorer Image 8](/img/Network-Stats.png)
139151

140-
### Epochs
152+
#### Epochs
141153

142154
In the Epochs section, you can analyze on a per-epoch basis, metrics such as:
143155

@@ -222,7 +234,7 @@ Within this tab, you’ll find an overview of:
222234

223235
![Explorer Image 14](/img/Curation-Stats.png)
224236

225-
## Your Profile Settings
237+
### Your Profile Settings
226238

227239
Within your user profile, you’ll be able to manage your personal profile details (like setting up an ENS name). If you’re an Indexer, you have even more access to settings at your fingertips. In your user profile, you’ll be able to set up your delegation parameters and operators.
228240

@@ -234,3 +246,11 @@ Within your user profile, you’ll be able to manage your personal profile detai
234246
As your official portal into the world of decentralized data, Graph Explorer allows you to take a variety of actions, no matter your role in the network. You can get to your profile settings by opening the dropdown menu next to your address, then clicking on the Settings button.
235247

236248
<div sx={{ mx: 'auto', maxWidth: '400px' }}>![Wallet details](/img/Wallet-Details.png)</div>
249+
250+
## Additional Resources
251+
252+
### Video Guide
253+
254+
For a general overview of Graph Explorer, check out the video below:
255+
256+
<VideoEmbed youtube="u224xf7rEBY" />

website/pages/en/subgraphs/querying/introduction.mdx

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,30 @@
22
title: Querying The Graph
33
---
44

5-
When a subgraph is published to The Graph Network, you can visit its subgraph details page on [Graph Explorer](https://thegraph.com/explorer) and use the "query" tab to explore the deployed GraphQL API for the subgraph, issuing queries and viewing the schema.
5+
To start querying right away, visit [The Graph Explorer](https://thegraph.com/explorer).
66

7-
> Please see the [Query API](/subgraphs/querying/graphql-api/) for a complete reference on how to query the subgraph's entities. You can learn about GraphQL querying best practices [here](/subgraphs/querying/best-practices/)
7+
## Overview
88

9-
> Note: If you encounter 405 errors with a GET request to the Graph Explorer URL, please switch to a POST request instead.
9+
When a subgraph is published to The Graph Network, you can visit its subgraph details page on Graph Explorer and use the "Query" tab to explore the deployed GraphQL API for each subgraph.
10+
11+
## Specifics
1012

11-
Each subgraph published to The Graph Network has a unique query URL in Graph Explorer for making direct queries that you can find by navigating to the subgraph details page and clicking on the "Query" button on the top right corner.
13+
Each subgraph published to The Graph Network has a unique query URL in Graph Explorer to make direct queries. You can find it by navigating to the subgraph details page and clicking on the "Query" button in the top right corner.
1214

1315
![Query Subgraph Button](/img/query-button-screenshot.png)
1416

1517
![Query Subgraph URL](/img/query-url-screenshot.png)
1618

17-
Learn more about querying from an application [here](/subgraphs/querying/from-an-application/).
18-
19-
As you can notice, this query URL must use a unique API key. You can create and manage your API keys in [Subgraph Studio](https://thegraph.com/studio), in the "API Keys" section. Learn more about how to use Subgraph Studio [here](/deploying/subgraph-studio/).
19+
You will notice that this query URL must use a unique API key. You can create and manage your API keys in [Subgraph Studio](https://thegraph.com/studio), under the "API Keys" section. Learn more about how to use Subgraph Studio [here](/deploying/subgraph-studio/).
2020

2121
Subgraph Studio users start on a Free Plan, which allows them to make 100,000 queries per month. Additional queries are available on the Growth Plan, which offers usage based pricing for additional queries, payable by credit card, or GRT on Arbitrum. You can learn more about billing [here](/subgraphs/billing/).
22+
23+
> Please see the [Query API](/subgraphs/querying/graphql-api/) for a complete reference on how to query the subgraph's entities.
24+
25+
> Note: If you encounter 405 errors with a GET request to the Graph Explorer URL, please switch to a POST request instead.
26+
27+
### Additional Resources
28+
29+
- Use [GraphQL querying best practices](/subgraphs/querying/best-practices/).
30+
- To query from an application, click [here](/subgraphs/querying/from-an-application/).
31+
- View [querying examples](https://github.com/graphprotocol/query-examples/tree/main).

0 commit comments

Comments
 (0)