search

drand / website

Drand webpage, docs and blog 📚
https://drand.love
Other
3 stars 13 forks source link

Docs update to note switch to unchained randomness #128

Closed yiannisbot closed 8 months ago

yiannisbot commented 2 years ago

Including a note in a couple of central places in the docs to note that docs are updated to include new features, but those are not yet available on mainnet.

yiannisbot commented 2 years ago

Preview looks ok: https://bafybeibmyabio7wv6oa4rv7spf7tq7iobn7ig2uafqm5r5p7hdsai43kle.on.fleek.co/docs/ - I would love feedback on the phrasing.

proto-sid commented 2 years ago

May I ask what is the motivation to include this specific section in our public docs? I am not comfortable about mentioning unreleased features in our public documentation as it does not serve any useful purpose and may only confuse the audience. This would have been helpful if we had some client libraries along with an alpha/beta release of the new Drand binary.

Nonetheless, here is an alternative proposal for the wording (I have avoided mentioning about specific timeline that is many months into the future):

"As of Q2 2022, the Drand network operated by the League of Entropy (LoE) (opens new window) is running a testnet that implements new features such as support for multiple variable-frequency beacons, and unchained randomness. You can read all the details in this blogpost (opens new window). The Drand documentation has been updated to include mention of these features for general awareness even though these features are not available as part of the Drand mainnet. All changes are backward compatible, and the LoE expects these new features to be available in the mainnet towards the end of 2022."

AnomalRoil commented 2 years ago

The further issue is that our current master is featuring the changes, but the latest published version v1.3.2 is not.

Also we should probably add a few extra notes here and there saying that using the drand client to test connection against the LoE nodes won't work because these are not exposed and only the HTTP endpoints are.

yiannisbot commented 2 years ago

IMO, if someone can use the new features through the HTTP endpoints to build/test new things, then this is already something desirable. Updating the docs would come together with the blogpost that I had suggested putting out on what can someone do with the new features on our testnet and how to make use of them. That was one of the purposes of having docs merged. The other was that it would explain things better for LoE partners.

But given we have postponed the blogpost until things land on mainnet, we can postpone merging this too. I won't fight for this given I see the team prefers to wait for mainnet upgrade.

CluEleSsUK commented 1 year ago

I guess this is a little out of date now :p do we want to update it with details of the real merge or are adding the chain hashes in the other PR enough?

CluEleSsUK commented 1 year ago

Revising this after discussion yesterday, I think actually we should close it - the multi-network changes have been in mainnet for a while now and we're now running fastnet. That said, we should either add a warning or documentation for G1/G2 swap, as it's not anywhere on the website right now