GridPlus / gridplus-sdk

SDK for communicating with the GridPlus Lattice1 hardware wallet
MIT License
50 stars 24 forks source link

Update ETH Staking Keys docs to reflect `lattice-eth2-utils` #510

Closed alex-miller-0 closed 1 year ago

alex-miller-0 commented 1 year ago

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.

alex-miller-0 commented 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...

douglance commented 1 year ago

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?

alex-miller-0 commented 1 year ago

What do you mean by manual vs automated docs?

douglance commented 1 year ago

Everything under the API heading is auto-generated.

alex-miller-0 commented 1 year ago

Gotcha.

Yeah so a few points here:

douglance commented 1 year ago

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.

alex-miller-0 commented 1 year ago

I agree. I guess we can just link to lattice-eth2-utils in a note for developers