Rockbox Development - Documentation

[chrisjj]

Where does one find topics that one might expect to find in a Rockbox Development / Documentation sub-forum, if such a sub-forum existed?

[karashata]

One should check the wiki, since that's where most of the documentation is kept. It makes more sense to have it on the wiki than it does to have it in a forum...

Try clicking the "docs index" link on the side navigation bar and have a look through there, I'm sure you'll find just about everything you might need.

You might also check the manual for your DAP if you're looking for any particular information pertaining to it.

[chrisjj]

One should check the wiki, since that's where most of the documentation is kept. It makes more sense to have it on the wiki than it does to have it in a forum...

Thanks, but I was referring not to documentation, but to discussion of documentation.

[Llorean]

Which documentation?

If you have questions about the documentation about a specific topic, just post in the forum section for that topic. For example, if you had questions about the WPS documentation, you'd post in the WPS section of the forum.

There are four subforums dedicated to Development subjects, if none of them fit your needs, what exactly is it you wish to ask questions about?

[chrisjj]

> There are four subforums dedicated to Development subjects

I expected to find one dedicated to Documentation, since this is part of development... no?

> if none of them fit your needs, what exactly is it you wish to ask questions about?

No questions. As I said, I was looking for topics.

[Llorean]

But documentation is about things. Documentation doesn't exist in a void, being about nothing. There is a platonic ideal documentation, perhaps, but that is beyond the scope of these forums.

So, please clarify exactly what you mean, rather than just repeating "I'm looking for a forum on documentation" again.

[chrisjj]

I think I've made a false assumption about the way Rockbox documentation development is managed. Apologies for bothering you.

[AlexP]

If you want to bring up errors in any parts of the documentation, then open a thread in the forum that the documentation refers to.  If it is general stuff, then the general discussion forum will be fine.

[chrisjj]

> If you want to bring up errors in any parts of the documentation,
> then open a thread in the forum that the documentation refers to.

Thank Alex but Guidelines imply not:

http://forums.rockbox.org/index.php?topic=5738.0
The forums are for two-way discussion/interaction.  One-way communication of information -- e.g. documentation, tutorials, or links to resources -- should be posted on the Rockbox Wiki

And Flyspray http://www.rockbox.org/tracker/newtask/proj1 categories exclude Docs... even though I do recall seeing some RB FS Docs entries before...

EDIT 2014-01-08 FTR, http://www.rockbox.org/tracker/newtask/proj1 Category now includes Manual. Thanks!

[bluebrother]

And Flyspray http://www.rockbox.org/tracker/newtask/proj1 categories exclude Docs... even though I do recall seeing some RB FS Doscs entries before...

There is an entry "manual" for the official documentation -- the manual.

[chrisjj]

Duh! Thanks.

Though I am kind of surprised there's no forum for discussion/screening of potential issues (whether in code or documentaion) before filing. I have found this very effective in getting other user input that increases the quality of filed issues, e.g in the many 100's I've filed for other products e.g. MediaMonkey recently.

[Chronon]

Plenty of discussion occurs on IRC and in individual tasks on Flyspray.

[torne]

Each bug entry is a discussion forum for discussing that issue...

If you aren't sure if it's a bug then again, we assume people will post it under whichever section it relates to. Not sure what the value of a specific forum for that is.

[AlexP]

> If you want to bring up errors in any parts of the documentation,
> then open a thread in the forum that the documentation refers to.

Thank Alex but Guidelines imply not:

http://forums.rockbox.org/index.php?topic=5738.0
The forums are for two-way discussion/interaction.  One-way communication of information -- e.g. documentation, tutorials, or links to resources -- should be posted on the Rockbox Wiki

And Flyspray http://www.rockbox.org/tracker/newtask/proj1 categories exclude Docs... even though I do recall seeing some RB FS Doscs entries before...

I meant for discussion if you are not sure it is wrong, sorry that wasn't clear.  For sure errors, use the manual entry on flyspray.

[chrisjj]

Each bug entry is a discussion forum for discussing that issue...

Sure, but way out of sight of most users.

If you aren't sure if it's a bug then again, we assume people will post it under whichever section it relates to.

One thing I am sure of is there are different meanings of "bug"

I'll trying reports in the forum as see how it goes.

Thanks.