Skip to content

Generate documentation for storage items and runtime constants

Main generated documentation is nice to dig in Duniter but can be a bit tough to explore. We should do the same as what was done for:

i.e. extract the docstrings and put them all in one markdown file.

That will allow to improve client developer documentation.

Example for pendingEvaluationRequest storage item. Doc page is https://doc-duniter-org.ipns.pagu.re/pallet_distance/pallet/type.PendingEvaluationRequest.html, but is cluttered with a lot of implementation detail information while the only relevant information is:

The pending evaluation requesters.

Storage type is [StorageMap] with key type < T as pallet_identity :: Config > :: IdtyIndex and value type < T as frame_system :: Config > :: AccountId.

All this will be listed here: https://duniter.org/wiki/duniter-v2/doc/#api-specs.

To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information