autonity / docs.autonity.org

Documentation for the Autonity Go Client (AGC)
https://docs.autonity.org
2 stars 6 forks source link

Automatically generate protocol contract documentation #216

Open aiman opened 3 months ago

aiman commented 3 months ago

Currently, the protocol contract documentation is maintained manually. However, this is not ideal because it can get out of sync with changes in the code base, and there is delayed feedback for the development team. It would be better if the docs are automatically generated from the Solidity source files directly. The source already contains a significant amount of documentation in the NatSpec format, but it is not used for rendering the docs.

The preliminary goal is to deliver:

aiman commented 1 month ago

To achieve this with current repo workflow, we'll either need:

My view on (A) is that we'd have a single top-level yaml/toml config, or reuse a Quarto one, and define our feature flags in there. And then rely on custom filters/scripts to propagate those flags in the right places, e.g. CSS class or hiding documents (draft: true/false).