As mentioned above, we need some documentation for the general public and some technical documentation aimed at developers.
Documentation for the general public (in about-ouroboros): A utxo-hd.md file describing the motivation for UTxO-HD, what users can expect from using either in-memory or LMDB, configuration options, installation requirements
Documentation for developers/technical documentation (in for-developers):
utxo-hd.md: high-level description of the feature and files structure. Maybe a section on how downstream packages are affected? (I think that's mostly having to use ledger tables and mapkinds in some places)
utxo-hd/ : markdown files for important concepts/components.
Design concepts (re-iterating parts of the utxo-db-api document, like the partitioned in-memory/on-disk representation)
Blog post
UTxO-HD will have an impact on the Cardano node performance for no apparent immediate benefit. We need to:
We need performance metrics so that the community can make an informed decision.
We will relay this information in the form of a draft blogpost to the Cardano Steering Committee.
Checklist
Important information to include
Structure
Currently, the
docs
folder is structured as follow:As mentioned above, we need some documentation for the general public and some technical documentation aimed at developers.
about-ouroboros
): Autxo-hd.md
file describing the motivation for UTxO-HD, what users can expect from using either in-memory or LMDB, configuration options, installation requirementsfor-developers
):utxo-hd.md
: high-level description of the feature and files structure. Maybe a section on how downstream packages are affected? (I think that's mostly having to use ledger tables and mapkinds in some places)utxo-hd/
: markdown files for important concepts/components.utxo-db-api
document, like the partitioned in-memory/on-disk representation)