Documentation: Organise it!

VorpalBlade / chezmoi_modify_manager

Tools for chezmoi to handle mixed settings and state

GNU General Public License v3.0

45 stars 5 forks source link

Documentation: Organise it! #112

Closed VorpalBlade closed 5 months ago

VorpalBlade commented 6 months ago

It is a bit all over the place currently:

In the README
In docs/
In --help-syntax and --help-transforms

Note that --help-transforms is generated from each transformation doc comment currently, so not ideal for generating markdown from. In general it would be nice to have a single source of truth to generate a github pages / mdbook from though.

VorpalBlade commented 5 months ago

This has now been done (a new mdbook based website has been created).

As a followup task, the --help-syntax output should be generated from the markdown file somehow. Possibly the same for --help-transforms.