docs: more changes in review process

Co-authored-by: Joseph Livesey <[email protected]>

Author: gusinacio

README.md

@@ -23,18 +23,21 @@ This section provides guidance for building, configuring, and running `indexer-s
 Pre-built Docker images are available for both `indexer-service-rs` and `indexer-tap-agent`. You can pull these images using the following commands:
 
 - **Indexer Service:**
+
 ```bash
 docker pull ghcr.io/graphprotocol/indexer-service-rs:<tag>
 ```
 
 - **TAP Agent:**
+
 ```bash
 docker pull ghcr.io/graphprotocol/indexer-tap-agent:<tag>
 ```
 
 The `<tag>` corresponds to the current release version, which can be found in the [Releases Page](https://github.com/graphprotocol/indexer-rs/releases).
 
 #### Tag Examples for Version X.Y.Z
+
 For version `X.Y.Z`, the available tags include:
 - `latest`
 - `vX.Y.Z`
@@ -55,17 +58,22 @@ Refer to the following badges for the latest release versions:
 To build the services locally, ensure you have the latest version of Rust installed. No additional plugins are required.
 
 #### Steps:
+
 1. Clone the repository:
+
 ```bash
 git clone https://github.com/graphprotocol/indexer-rs.git && cd indexer-rs
 ```
 
 2. Build the binaries:
 - **Indexer Service:**
+
   ```
   cargo build --release -p indexer-service-rs
   ```
+
 - **TAP Agent:**
+
   ```
   cargo build --release -p indexer-tap-agent
   ```
@@ -94,10 +102,13 @@ export INDEXER_SERVICE_SUBGRAPHS__NETWORK__QUERY_URL=<value>
 
 3. **Start the Service:**
 - **Indexer Service:**
+
   ```bash
   target/release/indexer-service-rs --config config/minimal-config-example.toml
   ```
+
 - **TAP Agent:**
+
   ```bash
   target/release/indexer-tap-agent --config config/minimal-config-example.toml
   ```
@@ -112,6 +123,7 @@ All configuration is managed through a TOML file. Below are examples of configur
 If you are migrating from an older stack, use the [Migration Configuration Guide](./docs/migration-config/README.md) for detailed instructions.
 
 ### Key Notes:
+
 - Ensure your configuration is tailored to your deployment environment.
 - Validate the configuration file syntax before starting the service.
 - Use environment variables to override sensitive settings like database credentials or API tokens where applicable.

docs/Queries.md

@@ -39,20 +39,24 @@ curl -X POST \
   --data '{"query": "{_meta{block{number}}}"}' \
   http://localhost:7600/subgraphs/id/QmacQnSgia4iDPWHpeY6aWxesRFdb8o5DKZUx96zZqEWrB
 ```
+
 ```json
 {
     "attestable": true,
     "graphQLResponse": "{\"data\":{\"_meta\":{\"block\":{\"number\":10666745}}}}"
 }
 ```
+
 ## Takes hex representation for subgraphs deployment id aside from IPFS hash representation
+
 ```bash
 curl -X POST \
   -H 'Content-Type: application/json' \
   -H 'Authorization: Bearer token-for-graph-node-query-endpoint' \
   --data '{"query": "{_meta{block{number}}}"}' \
   http://localhost:7600/subgraphs/id/0xb655ca6f49e73728a102219726ff678d61d8fb792874792e9f0d9887dc616600
 ```
+
 ```json
 {
     "attestable": true,
@@ -80,24 +84,30 @@ curl -X POST \
 ```bash
 curl http://localhost:7600/subgraphs/health/QmVhiE4nax9i86UBnBmQCYDzvjWuwHShYh7aspGPQhU5Sj
 ```
+
 ```json
 {
     "health": "healthy"
 }
 ```
 ## Unfound subgraph
+
 ```bash
 curl http://localhost:7600/subgraphs/health/QmacQnSgia4iDPWHpeY6aWxesRFdb8o5DKZUx96zZqEWrB
 ```
+
 ```json
 {
     "error": "Deployment not found"
 }
 ```
+
 ## Failed Subgraph
+
 ```bash
 curl http://localhost:7600/subgraphs/health/QmVGSJyvjEjkk5U9EdxyyB78NCXK3EAoFhrzm6LV7SxxAm
 ```
+
 ```json
 {
     "fatalError": "transaction 21e77ed08fbc9df7be81101e9b03c2616494cee7cac2f6ad4f1ee387cf799e0c: error while executing at wasm backtrace:\t    0: 0x5972 - <unknown>!mappings/core/handleSwap: Mapping aborted at mappings/core.ts, line 73, column 16, with message: unexpected null in handler `handleSwap` at block #36654250 (5ab4d80c8e2cd628d5bf03abab4c302fd21d25d734e66afddff7a706b804fe13)",
@@ -148,6 +158,7 @@ curl -X POST \
   --data '{"query": "{indexingStatuses {subgraph health}}"}' \
   http://localhost:7600/status
 ```
+
 ```json
 {
   "data": {
@@ -170,12 +181,14 @@ curl -X POST \
 ```
 
 ## Indexing status resolver - Filter out the unsupported queries
+
 ```bash
 curl -X POST \
   -H 'Content-Type: application/json' \
   --data '{"query": "{_meta{block{number}}}"}' \
   http://localhost:7600/status
 ```
+
 ```json
 {
   "errors": [
@@ -200,6 +213,7 @@ curl -X GET \
   --data '{"query": "{ costModels(deployments: [\"Qmb5Ysp5oCUXhLA8NmxmYKDAX2nCMnh7Vvb5uffb9n5vss\"]) { deployment model variables }} "}' \
   http://localhost:7300/cost
 ```
+
 ```json
 {
   "data": {

docs/migration-config/README.md

@@ -32,7 +32,7 @@ INDEXER_SUBGRAPHS__ESCROW__DEPLOYMENT_ID=<escrow deployment id>
 ```
 
 Users typically have an easier time using the config over 
-environment variables, we recomment moving your environment 
+environment variables, we recommend moving your environment 
 variables to plain text inside the config over time.
 
 ## Booleans inside config