Update Website Documentation
- Dominant language
- Perl
- Stars
- 2.1k
- Forks
- 139
- PR merge metrics
- No merged PRs in 30d
Description
About a year ago [#551](https://github.com/digint/btrbk/issues/551) was merged which corrected incorrect documentation. This change has yet to be reflected on the website's documentation:
https://digint.ch/btrbk/doc/btrbk.conf.5.html
Unless there is a reason to wait, like the next version update, it would be nice to update the website docs as the current options `default|` are quite different from `yes|no`; which at least for me caused a good bit of headache until I found this year-old issue.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the website page at https://digint.ch/btrbk/doc/btrbk.conf.5.html and compare its options with the correction described in issue #551. Update the website documentation so the current options use yes|no rather than default|, and verify that the published page reflects the corrected wording.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 62/100