Skip to content

Edit, Complete and Refactor Documentation according to 3 "user stories" #14

Closed
@huitseeker

Description

@huitseeker

Centralize and deploy light client documentation.

We would like the LC documentation & spec to

Places where some documentation can be found today:

I expect that our audience, depending on their exact nature, will require three different documents:

  1. as a Wormhole developer looking to productionize the LC, I will want to read an intro to the Aptos LC protocol, and an overview of the software package in the release,
  2. as an auditor, I will want to read a light client spec, and link to the chips added by the Lurk team to Sphinx,
  3. as a Wormhole Foudnation performance engineer, vetting the grant completion, I will want a specific process described with exacting precision of :
    • how to reproduce the benchmarking process (i.e. measuring the epoch change + block header verif e2e proof generation, and generating a number in seconds equal to the smaller of the two), described with exacting precision (including hardware, env variables, compiler options, the whole 9 yards),
    • a description of the reasoning behind this, including a link to the "client" program that runs parallel generation of block header and epoch change proof, justifying how the above "e2e latency" number adequately deals with the worst case scenario.

The entry point of our doc should be an "orientation" doc that dispatches the reader among the above 3 use cases. This "orientation" doc should be indiscutably easy to find and hard to miss.

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions