chore: update graphcast docs #73
Merged
Conversation
This file contains 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
hopeyen
reviewed
Aug 30, 2023
|
|
||
| ## Introduction | ||
|
|
||
| The Graphcast CLI enables sending one-off messages. Currently, its default behaviour is to construct and send a message of type `UpgradeIntentMessage`, which is used for the [Subgraph Upgrade Pre-sync feature](https://docs.graphops.xyz/graphcast/design-principles#subgraph-upgrade-pre-sync) of Subgraph Radio. |
There was a problem hiding this comment.
There is no default behavior anymore, subcommand is required.
It would be good to explain how the 2 current subcmd fit together for the presyncing feature
|
|
||
| The Graphcast CLI code is very extensible and could be altered to send any kind of Graphcast-compatible message to the network. | ||
|
|
||
| ## Run with Docker |
There was a problem hiding this comment.
Perhaps include a paragraph on what to expect when they run this command (potential logs and summaries)
There was a problem hiding this comment.
maybe we can have a more dedicated page for the presyncing feature overall, with concise description on the ideal flow and interaction of components. like the usage guide you mentioned writing
pete-eiger
force-pushed
the
petko/update-graphcast-docs
branch
from
5aa4500
to
a46ce7a
Compare
pete-eiger
force-pushed
the
petko/update-graphcast-docs
branch
from
a46ce7a
to
03f930d
Compare
hopeyen
reviewed
Aug 31, 2023
| sidebar_position: 3 | ||
| --- | ||
|
|
||
| # Subgraph upgrade pre-sync feature |
There was a problem hiding this comment.
include a workflow diagram here; you can edit from the existing one graphops/subgraph-radio#6
pete-eiger
force-pushed
the
petko/update-graphcast-docs
branch
from
03f930d
to
318cb66
Compare
pete-eiger
force-pushed
the
petko/update-graphcast-docs
branch
from
318cb66
to
7bbc6a8
Compare
pete-eiger
force-pushed
the
petko/update-graphcast-docs
branch
from
7bbc6a8
to
07aca8d
Compare
pete-eiger
force-pushed
the
petko/update-graphcast-docs
branch
from
07aca8d
to
f56597f
Compare
chriswessels
approved these changes
Sep 11, 2023
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.
one-shot-clitographcast-cliand refactor commands to reflect recent updatesindexing-statussubcommandVersionUpgradeMessagetoUpgradeIntentMessageRATELIMIT_THRESHOLDconfig var to variables tableupgradeIntentMessagesquery to graphql queries section