Skip to content

move to hand written man pages with automatic sync #1428

@cdrage

Description

@cdrage

Basically let's switch to maintaining the man pages in markdown, with some tooling that helps auto-sync CLI option switches from the Rust clap comments into the markdown.

Original issue follows:


Image

Throughout the docs, I am noticing a lot of backslashes in some of the generated pages.

For example on: https://bootc-dev.github.io/bootc/man/bootc-install-to-disk.html

You get:

The implementation of this uses systemd \`tmpfiles.d\`, writing to a
file named \`/etc/tmpfiles.d/bootc-root-ssh.conf\`. This will have
the effect that by default, the SSH credentials will be set if not
present. The intention behind this is to allow mounting the whole
\`/root\` home directory as a \`tmpfs\`, while still getting the SSH
key replaced on boot.

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions