Rockbox General > Rockbox General Discussion

Documentation Clean-up Week

<< < (2/2)

Llorean:
Actually, "what is the goal of the manual" would've been good for DevCon.

I think PluginIndex will always be necessary (just to have an easy reference as to what targets they're on) but I think the individual plugin pages should never be need.

Thus, yes, a VideoConversion page might be nice. I'd like, though, to settle on a single cross-platform method to recommend, rather than 400 different methods. Then we can actually try to provide limited support for that method (since we can actually be familiar with it). Then, the page can just document the specifics the output files must meet if made with other programs, and our one recommended method (which hopefully will eventually be RBUtil, though that may be a very long time coming).

MarcGuay:
Just a quick thought on the manual vs. the wiki:  If we move all user documentation to the manual it may fall even further behind due to the fact that it's more complicated and requires commit access to update.  Even if users can submit bug reports to the tracker pointing out shortcomings in the manual, they could, as they've been known to, rot there for a while before being noticed, if at all, whereas the wiki tends to be more up-to-date and have better language editing because of it's populist nature.  C'est tout.

Llorean:
The wiki also has a tendency to have very incorrect information (or at least misleading information, such as suggestions that the first step is to reformat a device, or whatever) because there is no review process for information to be included. So it kinda works both ways, at least the manual is "known good" information at the time of its writing.

Honestly, the documentation needs (in regard to stuff that belongs in the manual) shouldn't change that often anyway. And I think the intent is to put more pressure on those making commits that need documenting to actually get said documenting done. Most changes change things under the hood rather than in the UI anyway.

Navigation

[0] Message Index

[*] Previous page