Separate out reference documentation for command line arguments and config file #1300
Closed
2 tasks done
Labels
Milestone
Documentation Change
jrnl's documentation is somewhat incomplete but also a bit inconsistent in its approach. We get a fair amount of issues that I think are more about the problems with the docs than the program itself.
Lots of mature software projects tend to divide up documentation into four main areas:
I think we've done a good job on tutorials, but we've kind of mixed up the other three categories. In particular, some of our documentation seems to be trying to be both tutorial and reference at the same time and I think that hurts its ability to meet either need.
At the very least, we should add:
Once those two are added, we should rework the rest of the documentation that addresses arguments and the config file as necessary.
Affected Page(s)
Other Information
This piece on four types of documentation helped orient me towards this approach.
The text was updated successfully, but these errors were encountered: