now we have command-line options, and will hopefully have a settings file soon, there should be a user-facing manpage installed along with tooi.
there was some discussion about using Click to auto-generate the manpage here.
Thinking about toot as well as tooi. Ideally, documentation should contain:
- human-written documentation similar to https://toot.bezdomni.net/
- cli commands documentation generated from click commands
That doc should be:
- human readable in the repo (currently written in markdown for toot)
- convertable to a website like https://toot.bezdomni.net/ (toot uses mdbook)
- convertable to man pages (toot does not currently have man pages)
This would be my ideal scenario, but might take a bit of fiddling around.
do you think the tooi web-based / "book" documentation should be part of the toot documentation? this probably depends on how closely tooi is going to integrated with toot (i.e., is it "tooi" or "toot tooi"), which i think is still undecided right now.
Frankly, not sure yet.