docs: automatically generate command help documentation #1018
Conversation
|
Right now it is not really easy to search through documentation because everything is on the top level. Should we introduce a folder structure? |
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #1018 +/- ##
==========================================
- Coverage 70.18% 69.87% -0.31%
==========================================
Files 246 247 +1
Lines 10815 10862 +47
==========================================
Hits 7590 7590
- Misses 2547 2594 +47
Partials 678 678
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Before this PR, could you build a small docs structure to guide the readers by the hand with a set of README's, similar to how the fleeting docs is structured:
https://gitlab.com/hetznercloud/fleeting-plugin-hetzner/-/tree/main/docs?ref_type=heads
This is to follow the https://diataxis.fr/ pattern.
This PR removes the default value for the `Config` option and moves the logic into the config parsing itself. This is so that the user's home path is not shown in help output. This helps with reproducibility and also allows generating documentation. In preparation for #1018
phm07
force-pushed
the
auto-generate-docs
branch
from
bd3cd25 to
8b24e97
Compare
This PR adds auto-generated documentation for commands like described in #1016