Skip to content

Commit

Permalink
small change
Browse files Browse the repository at this point in the history
  • Loading branch information
Giuliano-1 committed Dec 16, 2024
1 parent cf44851 commit e7320da
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 11 deletions.
6 changes: 2 additions & 4 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
# Table of contents

## Substreams

* [Introduction](README.md)
* [Getting Started](new/explanation/getting-started.md)
* [Never Miss Data](new/explanation/reliability-guarantees.md)

## Tutorials

Expand Down Expand Up @@ -61,6 +58,7 @@
## Reference Material

* [Chains and endpoints](new/references/chains-and-endpoints.md)
* [Never Miss Data](new/explanation/reliability-guarantees.md)
* [Development Container Reference](new/references/devcontainer-ref.md)
* [Install the CLI](new/references/cli/installing-the-cli.md)
* [Authentication](new/references/cli/authentication.md)
Expand Down Expand Up @@ -94,6 +92,6 @@
* [Change log](release-notes/change-log.md)
* [FAQ](new/references/faq.md)

## Understanding Decentralized Indexing
## Decentralized Indexing

* [What is The Graph?](https://thegraph.com/docs/en/about/)
2 changes: 1 addition & 1 deletion docs/new/explanation/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,6 @@ To build and optimize your Substreams from zero, use the minimal path within the

## Learn

- **Substreams Reliability Guarantees**: With a simple reconnection policy, Substreams guarantees you'll never miss data [Reliability Guarantees](./references/reliability-guarantees.md).
- **Substreams Reliability Guarantees**: With a simple reconnection policy, Substreams guarantees you'll never miss data [Never Miss Data](../references/reliability-guarantees.md).
- **Substreams Architecture:**: For a deeper understanding of how Substreams works, explore the [architectural overview](architecture.md) of the data service.
- **Supported Networks**: Check-out which endpoints are supported [here](./references/chains-and-endpoints.md).
3 changes: 1 addition & 2 deletions docs/new/how-to-guides/sinks/stream/javascript.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,8 +202,7 @@ const stream = async (pkg, registry, transport) => {
for await (const statefulResponse of streamBlocks(transport, request)) {
/*
Decode the response and handle the message.
There different types of response messages that you can receive. You can read more about the response message in the docs:
https://substreams.streamingfast.io/documentation/consume/reliability-guarantees#the-response-format
There different types of response messages that you can receive. You can read more about the response message in the docs [here](../../../references/reliability-guarantees.md).
*/
await handleResponseMessage(statefulResponse.response, registry);

Expand Down
2 changes: 1 addition & 1 deletion docs/new/how-to-guides/sinks/subgraph/subgraph.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The subgraph will read the `EntityChanges` object and consume the data.

## What Option To Use
Both are valid options depending on the use case:
- Use the `graph_out` module is if your logic is entirely in the Substreams Rust code. You will create the subgraph entities in the Substreams and the subgraph will only read them. By putting your logic in the Substreams, you will **benefit from parallelism and you will be able to handle a cursor to track the progress of the data**. Read more about it in the [Reliability Guarantees](../../common/reliability-guarantees.md) section.
- Use the `graph_out` module is if your logic is entirely in the Substreams Rust code. You will create the subgraph entities in the Substreams and the subgraph will only read them. By putting your logic in the Substreams, you will **benefit from parallelism and you will be able to handle a cursor to track the progress of the data**. Read more about it in the [Never Miss Data](../../../references/reliability-guarantees.md) section.

- Use the **Substreams triggers** if you want to use Substreams as an extraction layer for the data, but the logic of your application will be in the subgraph AssemblyScript code. By putting all your logic in the subgraph, you will deal with an _easier_ programming language (AssemblyScript).

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@

## Reliability Guarantees

When you consume a Substreams package through the CLI (or through any of the different sinks available), you are establishing a gRPC connection with the Substreams provider (i.e. StreamingFast, Pinax...), which streams the data of every block back to your sink.

### The Response Format
Expand Down

0 comments on commit e7320da

Please sign in to comment.