Blueprint changes for better documentation generation #969
SebastienGllmt
started this conversation in
General
Replies: 1 comment
-
I released our tool that inspired this issue: https://twitter.com/SebastienGllmt/status/1808744947367170229 Hopefully the tool can evolve as these issues are addressed to become more generic instead of depending on Aiken-specifics |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Currently, documentation for Aiken projects has no good way to be generated:
aiken docs
as as command not only doesn't look great, it's also inflexible (it enforces a very specific format which makes it hard to integrate into different doc tools)plutus.json
doesn't have enough information to be a good source for documentation generationIn Ethereum, to solve this problem, they introduced a different format called
natspec
that generates a JSON file (see example here). This allows any doc generation tool to parse the resulting json instead of creating a tight coupling between the compiler and the generated documentation by the compilerSince we don't have this kind of tool for Aiken (and I'm not sure if anybody wants to spend time on this), I've instead been looking at getting code generated from
plutus.json
. However, it's missing the following issues:It would be nice to either address these issues in
plutus.json
, or at least consider a separate doc output format like Ethereum didBeta Was this translation helpful? Give feedback.
All reactions