Rockbox.org home
release
dev builds
extras
themes manual
wiki
device status forums
mailing lists
IRC bugs
patches
dev guide



Rockbox mail archive

Subject: Documentation: To do - please help

Documentation: To do - please help

From: Christi Alice Scarborough <christi_at_chiark.greenend.org.uk>
Date: 2005-01-04

Happy New Year, everyone,

Here's the current list of things that need doing for the manual:

     * Chapters 2-3 need updating to include Ondio keys and any other
Ondio specifics.

     * Chapter 5 needs Ondio keymaps added to all the Ondio compatible
plugins, and reference to key mappings in the text removing.

     * Whole document: No actual key information should be contained
within the body of the text. It should, in general be in tables. ideally
one for each platform.

     * The entire text needs checking for references to to Recorders.
Where appropriate, these should be updated to indicate that they also
apply to the Ondio.

     * Chapter 2 - document how to use flash cards with the Ondio.

Once these are done, the manual will fully cover the Ondio port. Other
stuff that needs to happen before the next release.

     * Add section on restoring original firmware

     * Document flashing the player

     * Document recording beeps.

But I can't do it alone. In particular my eratic health means that my
work on the manual tends to be in fits and starts. If we're to prevent
the manual becoming an overwhelming task again, this to do list needs to
be kept small.

If you have some free time and would like to give something back to
Rockbox, please consider taking on one of the tasks above. Rockbox is
currently one of the best documented free software projects, and I'd
love to be able to keep it that way. Perfect English is not a
prerequisite, since I'm happy to edit anything that's produced. If
you'd like to discuss taking something on, please feel free to email me
about it.

For more info about writing the Rockbox documentation, please take a
look at:

http://www.rockbox.org/twiki/bin/view/Main/DocBox

Thanks,

Christi
Rockbox Documentation Team
_______________________________________________
http://cool.haxx.se/mailman/listinfo/rockbox
Received on Wed Jan 5 10:20:23 2005


Page was last modified "Jan 10 2012" The Rockbox Crew
aaa