Rockbox General > Rockbox General Discussion

Have you read the Rockbox Manual?

<< < (4/27) > >>

aegis:
Re: actual question - well, I'm just getting started. :)

But putting the thing straight - there is a pretty nice guide on the wiki, for instance how to install and what features are actually present (well, it's pretty hard to start without that info 8) ) and it's fair enough for me (I'm a sysop on Wikipedia and although it's not MediaWiki but tech wiki I get the idea :) ).

That's why maintaining the wiki is IMHO crucial. AFAIR there was one typo in iPod section in one of instructions to put in the command line but I'm pretty sure it has been corrected so far.

Maybe it's a Polish culture of not reading manuals, but Rockbox is still not a rocket science and you can use it effectively when you read forums and wiki. Of course it's nice to have this _complete_ manual somewhere to learn or send somebody to learn more easily (esp. if one has little time). But certainly tasks like compiling, porting to Rockbox, debugging, translating etc. require much more detailed knowledge and looking into documentation than just using it on day-to-day basis.

And I think it's good - Music Players should be simple enough to be used without reading the manual.  :)
Rockbox delivers that.

Jillorious:
I read through the entire manual three to 4 times PRIOR to instalation. After instalation I've used it just to make sure that i understood everything correctly.
Call me a communist, but I personaly do think that anybody that hasn't read the manual should be banned from the forums until he/she has done so. Maybe there should be some kind of test upon registration.

Febs:

--- Quote from: aegis on August 22, 2006, 11:31:43 AM ---But putting the thing straight - there is a pretty nice guide on the wiki, for instance how to install and what features are actually present (well, it's pretty hard to start without that info 8) ) and it's fair enough for me (I'm a sysop on Wikipedia and although it's not MediaWiki but tech wiki I get the idea :) ).

That's why maintaining the wiki is IMHO crucial.
--- End quote ---
The problem with the wiki is that as the number of supported Rockbox platforms increases, it becomes extremely difficult to maintain separate wiki pages for each supported platform.  The manual, on the other hand, is set up in LaTex, so it can be configured relatively easily to support multiple platforms. 

Now that the manual is available not only in PDF form but also in HTML form, my personal feeling is that it should supplant the wiki page.  Obviously, that would make it more difficult for individuals to edit the documentation.  However, the upside is that we can maintain documentation that is customized for each supported platform.  Those with commit access can make changes directly to the manual; users without commit access can still make changes to the manual through use of the patch tracker.

aegis:
Well... the idea of having just one manual is certainly tempting for the developers.

However, Wiki is not that bad. :) If you have the same content for multiple platforms, one common Wiki page will be just enough. And personally if I am looking for one certain thing Wiki seems to be more efficient for me.
Certainly if maintaining it requires too much effort, the number of Wiki pages should be simply reduced. But I'm not sure it's necessary; and I think Wiki is "more natural" to maintain for Rockbox users than manual and certainly through Flyspray.

Maybe if there were more explicit policy "Wiki for users. Help to maintain." it would solve some problems - or maybe not.
Results are hard to predict here.

bascule:

--- Quote from: Jillorious on August 22, 2006, 12:01:20 PM ---Call me a communist, but I personaly do think that anybody that hasn't read the manual should be banned from the forums until he/she has done so. Maybe there should be some kind of test upon registration.

--- End quote ---

LOL - I totally agree


--- Quote from: aegis on August 23, 2006, 05:43:06 AM ---...and I think Wiki is "more natural" to maintain for Rockbox users than manual and certainly through Flyspray.

--- End quote ---

Agree with this as well. Once past the Wiki concept learning curve, I've found it quite easy. However, the whole rigmarole of download, install, learn and configure CVS, learn what source code looks like, make updates, build a manual to check etc., etc. puts me right off doing proper manual updates

Navigation

[0] Message Index

[#] Next page

[*] Previous page

Go to full version