Revamp the toplevel and the docker README #5979
Merged
+89
−917
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@alex-pakalniskis @idalithb I would love your take on this, in particular the new README It's still a little too intimidating for my taste |
alex-pakalniskis
approved these changes
May 8, 2025
idalithb
approved these changes
May 8, 2025
README.md
Outdated
| @@ -3,193 +3,113 @@ | |||
| [](https://github.com/graphprotocol/graph-node/actions/workflows/ci.yml?query=branch%3Amaster) | |||
| [](docs/getting-started.md) | |||
|
|
|||
| [The Graph](https://thegraph.com/) is a protocol for building decentralized applications (dApps) quickly on Ethereum and IPFS using GraphQL. | |||
| [The Graph](https://thegraph.com/) is a protocol that organizes and serves web3 data. | |||
There was a problem hiding this comment.
Suggested change
| [The Graph](https://thegraph.com/) is a protocol that organizes and serves web3 data. | |
| ## Overview | |
| [The Graph](https://thegraph.com/) is decentralized protocol that organizes and distributes blockchain data across the leading Web3 networks. A key component of The Graph's tech stack is Graph Node. |
README.md
Outdated
Comment on lines
10
to
14
| You can find more details on how to write these transformations, called | ||
| _subgraphs_, in the official [Graph | ||
| documentation](https://thegraph.com/docs/en/subgraphs/quick-start/). If you | ||
| are not familiar already with subgraphs, we highly recommend at least | ||
| reading through that documentation first. |
There was a problem hiding this comment.
Suggested change
| You can find more details on how to write these transformations, called | |
| _subgraphs_, in the official [Graph | |
| documentation](https://thegraph.com/docs/en/subgraphs/quick-start/). If you | |
| are not familiar already with subgraphs, we highly recommend at least | |
| reading through that documentation first. | |
| Before using `graph-node,` it's highly recommended that you read the [official Graph documentation]((https://thegraph.com/docs/en/subgraphs/quick-start/) to understand Subgraphs, which are schema-driven APIs. |
README.md
Outdated
|
|
||
| For detailed instructions and more context, check out the [Getting Started Guide](docs/getting-started.md). | ||
| The rest of this page is geared towards two audiences: |
There was a problem hiding this comment.
Suggested change
| The rest of this page is geared towards two audiences: | |
| This guide is for: | |
| 1. Subgraph developers who want to run `graph-node` locally to test their Subgraphs during development | |
| 2. Contributors who want to add features or fix bugs to `graph-node` itself |
README.md
Outdated
Comment on lines
18
to
21
| 1. Subgraph developers who want to run `graph-node` locally so they can test | ||
| their subgraphs during development | ||
| 2. Developers who want to contribute bug fixes and features to `graph-node` | ||
| itself |
There was a problem hiding this comment.
Suggested change
| 1. Subgraph developers who want to run `graph-node` locally so they can test | |
| their subgraphs during development | |
| 2. Developers who want to contribute bug fixes and features to `graph-node` | |
| itself |
| their subgraphs during development | ||
| 2. Developers who want to contribute bug fixes and features to `graph-node` | ||
| itself | ||
|
|
| Ethereum network name (e.g. 'mainnet'), optional comma-separated capabilities (eg full,archive), and an Ethereum IPC pipe, separated by a ':' | ||
| When `graph-node` starts, it prints the various ports that it is listening on. | ||
| The most important of these is the GraphQL HTTP server, which is by default | ||
| is at `http://localhost:8000`. You can use routes like `/subgraphs/name/<subgraph-name>` |
There was a problem hiding this comment.
Suggested change
| is at `http://localhost:8000`. You can use routes like `/subgraphs/name/<subgraph-name>` | |
| at `http://localhost:8000`. | |
| You can use routes like `/subgraphs/name/<subgraph-name>` |
README.md
Outdated
| --subgraph <[NAME:]IPFS_HASH> Name and IPFS hash of the subgraph manifest | ||
| --ws-port <PORT> Port for the GraphQL WebSocket server [default: 8001] | ||
| ``` | ||
| Instructions for how to deploy subgraphs can be found [here](https://thegraph.com/docs/en/subgraphs/developing/introduction/) After setting up `graph-cli` as described there, you can deploy a subgraph to your local Graph Node instance. |
There was a problem hiding this comment.
Suggested change
| Instructions for how to deploy subgraphs can be found [here](https://thegraph.com/docs/en/subgraphs/developing/introduction/) After setting up `graph-cli` as described there, you can deploy a subgraph to your local Graph Node instance. | |
| Follow the [Subgraph deployment guide](https://thegraph.com/docs/en/subgraphs/developing/introduction/). After setting up `graph-cli` as described, you can deploy a Subgraph to your local Graph Node instance. |
|
|
||
| Very large `graph-node` instances can also be configured using a |
There was a problem hiding this comment.
Suggested change
| Very large `graph-node` instances can also be configured using a | |
| > Please note: Very large `graph-node` instances can also be configured using a |
README.md
Outdated
|
|
||
| Graph Node is an open source Rust implementation that event sources the Ethereum blockchain to deterministically update a data store that can be queried via the GraphQL endpoint. | ||
| Graph Node extracts and transforms blockchain data and makes the transformed | ||
| data available to decentralized applications (dApps) via GraphQL queries. |
There was a problem hiding this comment.
Suggested change
| data available to decentralized applications (dApps) via GraphQL queries. | |
| data available to decentralized applications (dapps) via GraphQL queries. |
README.md
Outdated
|
|
||
| ### Prerequisites | ||
|
|
||
| To build and run this project you need to have the following installed on your system: | ||
|
|
||
| - Rust (latest stable) – [How to install Rust](https://www.rust-lang.org/en-US/install.html) | ||
| - Note that `rustfmt`, which is part of the default Rust installation, is a build-time requirement. | ||
| - PostgreSQL – [PostgreSQL Downloads](https://www.postgresql.org/download/) | ||
| has general instructions. Run `rustup install stable` in this directory to make |
There was a problem hiding this comment.
Suggested change
| has general instructions. Run `rustup install stable` in this directory to make | |
| Run `rustup install stable` in this directory to make |
These were woefully out of date and utterly confusing
That file is way out of date and duplicate the official documentation on thegraph.com
|
@idalithb Thanks a ton for the detailed review. I've incorporated most of your suggestions - thanks so much for turning this into actual English ;) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
These were woefully out of date and utterly confusing