Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

[documentation] Auto-generate Kagami docs from clap #3509

Closed
0x009922 opened this issue May 22, 2023 · 1 comment
Closed

[documentation] Auto-generate Kagami docs from clap #3509

0x009922 opened this issue May 22, 2023 · 1 comment
Labels
Documentation Documentation changes Enhancement New feature or request iroha2-dev The re-implementation of a BFT hyperledger in RUST

Comments

@0x009922
Copy link
Contributor

0x009922 commented May 22, 2023

Description

The documentation for Kagami (in its README) is outdated. It will be even more outdated after the merge of #3475.

Your suggestions

Use clap-markdown or similar tool.

@0x009922 0x009922 added Enhancement New feature or request iroha2-dev The re-implementation of a BFT hyperledger in RUST Documentation Documentation changes labels May 22, 2023
@0x009922
Copy link
Contributor Author

0x009922 commented Jun 8, 2023

After a discussion with the team, we decided that it doesn't worth to have Kagami Markdown-rendered documentation at all. Since it is a CLI utility app with no stable API (at least for now), it isn't worth effort to keep the documentation up-to-date with manual approach. As for automatic approach, #3510 shown that it doesn't work well: if we focus on Markdown-oriented help message, we have to sacrifice the usability of CLI-oriented help message. We decided that CLI interface has a higher priority.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
Documentation Documentation changes Enhancement New feature or request iroha2-dev The re-implementation of a BFT hyperledger in RUST
Projects
None yet
Development

No branches or pull requests

1 participant