Closed alex-miller-0 closed 1 year ago
Perhaps we should actually move this to a new section... it doesn't really belong with the other sections, which describe how to do things with the SDK. Here we should explain how to do things with another tool, which happens to itself use the SDK...
We could move all the docs to docs.gridplus.io
. It's not ideal, but we can ship markdown to that service, so I bet we could migrate over in a few hours. The biggest issue with that would be ongoing maintenance.
Perhaps we move all the manual docs to the docs.gridplus.io
, then keep the automated docs as a reference? Or just remove the automation entirely?
What do you mean by manual vs automated docs?
Everything under the API heading is auto-generated.
Gotcha.
Yeah so a few points here:
lattice-eth2-utils
. I'm not sure where to put these docs. One option is to create a new section for "using external utils" or something and put the ETH2 stuff in there. Another option is to add a very short description of lattice-eth2-utils
and link out from the SDK docs, then to add an explanation of the CLI actions in the official GP docs. In the CLI docs we will also link out to lattice-eth2-utils
for developers.Actually, it might make sense to just put all the staking stuff into docs.gridplus.io
because it's really end-user content. It's not technically for developers. It's for users of the Lattice.
I agree. I guess we can just link to lattice-eth2-utils
in a note for developers
In #508 we removed bespoke test functionality related to BLS in favor of using
lattice-eth2-utils
.I forgot to update the docs, which are now out of date: https://gridplus.github.io/gridplus-sdk/tutorials/ethDeposits
We should update the docs and maybe ship a fix version so that people don't get confused looking at that.