Skip to content

Commit e609a75

Browse files
Docs/patch 1 (#1001)
* explorer.mdx mistake: 'In the The Curators table' * best-practices: fixed 'handled by the GraphQL server The GraphQL' * best-practices: "Dos" is a simple plural (not possessive) - apostrophe removed * best-practices: removed extra article * querying-graph-client: sentence had extra words * 'tools provided' are plural and then described as singular. It was written more like 'this repo' was the subject. Fixed. * querying-graph-client: fixed comma misuse. * querying-graph-client: cleaned a sentence up to read more efficiently. * 'As long as there a no conflicts' changed to 'As long as there are no conflicts' * 'has' becomes 'have' because 'client libraries like...' is pluralizing the subject. * 'a' changed to 'an'
1 parent bf65e75 commit e609a75

File tree

3 files changed

+11
-11
lines changed

3 files changed

+11
-11
lines changed

website/src/pages/en/subgraphs/explorer.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ Curators analyze Subgraphs to identify which Subgraphs are of the highest qualit
116116
- By depositing GRT, Curators mint curation shares of a Subgraph. As a result, they can earn a portion of the query fees generated by the Subgraph they have signaled on.
117117
- The bonding curve incentivizes Curators to curate the highest quality data sources.
118118

119-
In the The Curator table listed below you can see:
119+
In the Curators table listed below you can see:
120120

121121
- The date the Curator started curating
122122
- The number of GRT that was deposited

website/src/pages/en/subgraphs/querying/best-practices.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ const result = await execute(query, {
154154
Static strings have several **key advantages**:
155155

156156
- Queries are easier to read, manage, and debug.
157-
- Variable sanitization is handled by the GraphQL server The GraphQL.
157+
- Variable sanitization is handled by the GraphQL server.
158158
- Variables can be cached at the server level.
159159
- Queries can be statically analyzed by tools (see [GraphQL Essential Tools](/subgraphs/querying/best-practices/#graphql-essential-tools-guides)).
160160

@@ -362,9 +362,9 @@ When using the types generation tool, the above query will generate a proper `De
362362

363363
## GraphQL Fragment Guidelines
364364

365-
### Do's and Don'ts for Fragments
365+
### Dos and Don'ts for Fragments
366366

367-
1. Fragments cannot be based on a non-applicable types (types without fields).
367+
1. Fragments cannot be based on non-applicable types (types without fields).
368368
2. `BigInt` cannot be used as a fragment's base because it's a **scalar** (native "plain" type).
369369

370370
Example:

website/src/pages/en/subgraphs/querying/graph-client/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ This repo is the home for [The Graph](https://thegraph.com) consumer-side tools
44

55
## Background
66

7-
The tools provided in this repo are intended to enrich and extend the DX, and add the additional layer required for dApps in order to implement distributed applications.
7+
The tools provided in this repo are intended to enrich and extend the DX, and add the additional layer required for dApps to implement distributed applications.
88

99
Developers who consume data from [The Graph](https://thegraph.com) GraphQL API often need peripherals for making data consumption easier, and also tools that allow using multiple indexers at the same time.
1010

1111
## Features and Goals
1212

1313
This library is intended to simplify the network aspect of data consumption for dApps. The tools provided within this repository are intended to run at build time, in order to make execution faster and performant at runtime.
1414

15-
> The tools provided in this repo can be used as standalone, but you can also use it with any existing GraphQL Client!
15+
> The tools provided in this repo can be used as standalones, but you can also use them with any existing GraphQL Client!
1616
1717
| Status | Feature | Notes |
1818
| :----: | ---------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
@@ -67,7 +67,7 @@ graphclient build
6767

6868
> Note: you need to run this with `yarn` prefix, or add that as a script in your `package.json`.
6969
70-
This should produce a ready-to-use standalone `execute` function, that you can use for running your application GraphQL operations, you should have an output similar to the following:
70+
This should produce a ready-to-use standalone `execute` function that you can use for running your application GraphQL operations. You should have an output similar to the following:
7171

7272
```sh
7373
GraphClient: Cleaning existing artifacts
@@ -80,7 +80,7 @@ GraphClient: Reading the configuration
8080
🕸️: Done! => .graphclient
8181
```
8282

83-
Now, the `.graphclient` artifact is generated for you, and you can import it directly from your code, and run your queries:
83+
Now that the `.graphclient` artifact is generated for you, you can import it directly from your code, and run your queries:
8484

8585
```ts
8686
import { execute } from '../.graphclient'
@@ -449,7 +449,7 @@ sources:
449449
endpoint: https://api.thegraph.com/subgraphs/name/graphprotocol/compound-v2
450450
```
451451

452-
As long as there a no conflicts across the composed schemas, you can compose it, and then run a single query to both Subgraphs:
452+
As long as there are no conflicts across the composed schemas, you can compose it, and then run a single query to both Subgraphs:
453453

454454
```graphql
455455
query myQuery {
@@ -482,7 +482,7 @@ For advanced use-cases with composition, please refer to the following resources
482482

483483
If your project is written in TypeScript, you can leverage the power of [`TypedDocumentNode`](https://the-guild.dev/blog/typed-document-node) and have a fully-typed GraphQL client experience.
484484

485-
The standalone mode of The GraphQL, and popular GraphQL client libraries like Apollo-Client and urql has built-in support for `TypedDocumentNode`!
485+
The standalone mode of The GraphQL, and popular GraphQL client libraries like Apollo-Client and urql have built-in support for `TypedDocumentNode`!
486486

487487
The Graph Client CLI comes with a ready-to-use configuration for [GraphQL Code Generator](https://graphql-code-generator.com), and it can generate `TypedDocumentNode` based on your GraphQL operations.
488488

@@ -530,7 +530,7 @@ This is helpful since you can implement custom code as part of your GraphQL sche
530530

531531
> This document explains how to add custom mutations, but in fact you can add any GraphQL operation (query/mutation/subscriptions). See [Extending the unified schema article](https://graphql-mesh.com/docs/guides/extending-unified-schema) for more information about this feature.
532532

533-
To get started, define a `additionalTypeDefs` section in your config file:
533+
To get started, define an `additionalTypeDefs` section in your config file:
534534

535535
```yaml
536536
additionalTypeDefs: |

0 commit comments

Comments
 (0)