Satty icon indicating copy to clipboard operation
Satty copied to clipboard

Documentation

Open gabm opened this issue 2 years ago • 1 comments

With the increasing number of configuration options #30, we also need better documentation to explain them to the users. I want this to be available on the web-page (github, maybe a domain) in a searchable and readable form as well as a man page. Ideally we only have one source of truth for this.

As for the man pages, a lot of projects seem to use scd nowadays...

gabm avatar Dec 06 '23 11:12 gabm

This applies to script examples as well. We could place those in a subfolder in the medium term, I assume that can be automatically considered with static side generation.

Just leaving that comment here so we can merge #208 for now, and worry about cleaning up later.

RobertMueller2 avatar May 20 '25 05:05 RobertMueller2