Closed concussious closed 1 week ago
I appreciate the effort and understand that having no manpage can be confusing. But I worry about having to maintain a manpage and a wiki in sync, this isn't something I'd like to do. Would it be ok to instead just have a link to the wiki when you run amfora --help
?
I believe that $cmd --help
is a very good first guess once it becomes evident that the manual was omitted. I believe there are many people who would be satisfied with your software, who are not satisfied with guessing where to find documentation outside of work requirements.
The manual is now more comprehensive than the wiki. If this pull is accepted, all users will already have a manual, there will be no need to maintain/host a wiki.
I'm sorry but I'm not interested in maintaining both a man page and wiki at the moment. Ideally Amfora would have a man page, but I can't commit to it right now.
Given the rate of development (3 commits in nearly 7 months), I am willing to maintain a manpage alongside the wiki if that's your worry. Alternatively, you could always add a note to the manpage saying, "This reference may be out-of-date; see the wiki at https://.../ for up-to-date documentation".
@aabacchus @concussious if either of you open to maintaining the man page and add that note I'd be happy to merge this, thanks.
Thanks @makew0rld!
Here is some in-band documentation in mdoc. I think you should accept my pull request because Amfora is in your terminal. Man pages are the standard way of documentation in the terminal for generations. I think this is the lightest, fastest, most predictable and most reliable form of documentation. I am willing to maintain this man page.