unikraft / kraftkit

Build and use highly customized and ultra-lightweight unikernel VMs.
https://unikraft.org/docs/cli
BSD 3-Clause "New" or "Revised" License
226 stars 62 forks source link

Add man pages for kraftkit #1704

Open thass0 opened 3 months ago

thass0 commented 3 months ago

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

2k4sm commented 2 months ago

Hey @thass0 and @nderjung i would like to work on this issue can you assign me on this.

2k4sm commented 1 month ago

Hey @nderjung as i haven't heard anything from you so i will be moving forward to start working on this issue. I will be creating a draft PR as soon as i make some progress.

thass0 commented 1 month ago

I'm not aware of anybody else working on this so feel free go ahead.

ajinkyagawali1 commented 1 month ago

Hi, noticing that this issue is still open, I am interested to contribute. I also have a prototype of the man page ready.

thass0 commented 1 month ago

@ajinkyagawali1 Sounds cool! @2k4sm are you still working on this?

ajinkyagawali1 commented 1 month ago

Should I open a pull request.