Autogenerated CLI documentation

[ruben-arts]

Why

Pixi's CLI is growing and moving in a quick pace. Our documentation could benefit from some more automation.

Inspiration

Tools like pnpm npm nushell in our opinion have a good (semi) autogenerated CLI documentation.

Goal

• Autogenerated, code as source of truth, run by a CI job
• Ability to work with normal mkdocs markdown to extend the reference. Like npm does with their semi automated configuration.
• Single page per command, e.g. https://pnpm.io/cli/add
• A table of contents page
• Split the commands into categories, an obvious example would be splitting pixi global into its own part.

Feel free to join this venture to create amazing CLI docs for pixi! Input is very welcome!