You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
On Unix-like systems, virtually all core applications and many system features have "man pages" that hold relevant documentation. I would be cool if kraftkit also had such a man pages. This way, one could run man kraft locally to read up on kraftkit documentation.
Kraftkit uses cobra for it's CLI, and cobra can auto-generate documentation based on the CLI. This includes generating man pages. In addition to that, there is the gendocs tool in krafkit that generates CLI docs in a different format than cobra would. The output of the gendocs tool is used verbatim in the kraftkit and Unikraft online docs. That's why the format is different.
To add man pages to kraftkit:
generate man pages from the CLI
modify the kraftkit installer scripts to make them install the man pages on the user's system (and maybe ask them if they want that)
Describe alternatives
There are web docs and the kraft command itself can display help information.
Related architectures
None
Related platforms
None
Additional context
No response
The text was updated successfully, but these errors were encountered:
Feature request summary
On Unix-like systems, virtually all core applications and many system features have "man pages" that hold relevant documentation. I would be cool if kraftkit also had such a man pages. This way, one could run
man kraft
locally to read up on kraftkit documentation.Kraftkit uses cobra for it's CLI, and cobra can auto-generate documentation based on the CLI. This includes generating man pages. In addition to that, there is the gendocs tool in krafkit that generates CLI docs in a different format than cobra would. The output of the gendocs tool is used verbatim in the kraftkit and Unikraft online docs. That's why the format is different.
To add man pages to kraftkit:
Describe alternatives
There are web docs and the
kraft
command itself can display help information.Related architectures
None
Related platforms
None
Additional context
No response
The text was updated successfully, but these errors were encountered: