-
Notifications
You must be signed in to change notification settings - Fork 6
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: Chainstack implementation update #6
Conversation
Update repo URL with: https://github.com/ApeWorX/ape-chainstack
Update README with clear instructions
Remove Kovan as it is not supported by Chainstack
This time should not have conflict as I re-forked the repo with your updates (I only removed Kovan because is not supported by Chainstack) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good! Quick recommendation is to change reference to the Ape Framework vs ApeWorX the organization.
Co-authored-by: NotPeopling2day <[email protected]>
Co-authored-by: NotPeopling2day <[email protected]>
Co-authored-by: NotPeopling2day <[email protected]>
Co-authored-by: NotPeopling2day <[email protected]>
Co-authored-by: NotPeopling2day <[email protected]>
Co-authored-by: NotPeopling2day <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking good!
Consider my feedback on the networks list thought
README.md
Outdated
``` | ||
|
||
This is a list and syntax of the networks available once you install the Chainstack plugin. | ||
|
||
```bash |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider an explanation instead of enumerating all the options here. Something like:
You compose the network option by following this formula: <ecosystem>:<network>:<provider> where "chainstack" is the provider.
See the full output of networks in your ape instance by using the command `ape networks list`.
For more information on networking un ape, see [this guide (https://docs.apeworx.io/ape/stable/userguides/networks.html).
Let's say we increase support for new networks in chainstack; this list will become outdated. I am trying to avoid someone having to keep this documentation up to date as the plugin grows.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Linking to this doc is probably sufficient https://docs.apeworx.io/ape/stable/userguides/networks.html
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
true, you can go ahead and propose the change if you can, it's probably quicker like that than if I change it later
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I actually updated it in on my side. What is a good way to implement it here now?
Co-authored-by: Juliya Smith <[email protected]>
Co-authored-by: Juliya Smith <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you so much!
What I did
setup.py
to https://github.com/ApeWorX/ape-chainstackproviders.py
as it's not supported by ChainstackChecklist