Rockbox General > Rockbox General Discussion

Documentation Clean-up Week

(1/2) > >>

MarcGuay:
I noticed that there was some talk of organizing a Docs Clean-up Week at the DevCon and thought I'd take the lead on this one and see if I can't at least get some ideas organized.  So if you have any suggestions on where/how the documentation (either the wiki or the manual) can be improved in any way, you opinions would be greatly appreciated. 

I figured that there's no reason to create a new wiki page when we already have one basically set up at http://www.rockbox.org/twiki/bin/view/Main/ManualTodo.  I cleaned the plugins section but the rest could use some review. 

Some thoughts:

- Perhaps purging that page and starting from scratch would be easier than updating it.

- It might be wise to find a nice way to merge the WikiHome page with the Documentation Index so that there aren't two focal points to the wiki.

- Are there things in this wiki section that belong in the manual or vice versa? http://www.rockbox.org/twiki/bin/view/Main/DocsIndex#User_Interface

- Is there a plan for the flyspray feature requests?

- It needs to be decided if BatteryFAQ and LiIonFAQ are Archos-only or not.  If they are, make it clear, and if not, update them to be more universal.

- The flashing procedure for the Archos in the manual is a mess.  Tom Cole recently updated the wiki pages to be less confusing, so perhaps they could simply be copied to the manual and have the wiki pages deprecated.

Llorean:
In regard to flyspray feature requests: What are you asking?

MarcGuay:
I'm wondering if they're going to left as they are as a repository of ideas, or perhaps filtered-through and only keep those which have specific developer interest, or all be closed and only have new ideas opened as patches.  As it stands the Feature Request/Idea part of the project is in an unclear state.

Llorean:
The intent is to reopen the feature request tracker in a manner where only developers can add features to it, so that it's not just a list of pie-in-the-sky ideas. Right now few developers are interested in even reading through it because there's so much noise on it.

Basically, we should probably close all existing feature requests. There hasn't been a final decision on whether we should close all of them, and reopen the ones individual developers find specific merit in, or close all the ones individual developers think there's no merit in. I personally think the first path will be most effective (since in the end, the second path will probably have the same result, just with more overall work).

MarcGuay:
Any opinions on moving the Plugins wiki pages to the junkyard once they've all been added to the manual?  Is the MpegPlayer page an exception, or do we start a new VideoConversion page for the remaining dynamic information? 

I'm thinking that we may need to wait for the steering board to be created in order to decide on some "does this belong in the wiki or the manual?" and "what is the goal of the manual?" decisions.

Navigation

[0] Message Index

[#] Next page