Rockbox General > Rockbox General Discussion
Wiki Cleanup
MarcGuay:
It's great to see other people getting keen on maintaining the documentation. Keep it up! There was a mention of a "documentation-binge week" at the DevCon which I'd love to see followed through on.
On another note, I had a few ideas recently that I'd like some feedback on before going ahead with. They're tiny little shifts but noticible enough that other opinions would be nice:
1) Move the Rockbox Museum stuff to it's own page, it's really just a pile of crap which might come in handy someday and therefore doesn't need to be easily accessed frequently through the DocsIndex.
and
2) Shift the HardwareProjects page to the DocsIndex so that those pages are more easily accessible, particularly the HardDriveReplacement page which seems rather popular.
Rocque on.
P.S. Strife89: I've had a note on my desktop that says "FIX BLINDFAQ" for months now because it suffers from the same out-of-dateness as the Battery FAQ... If you've got some extra time? :)
Strife89:
Hopefully I can do it in bits and pieces throughout this week. :)
EDIT: If you don't mind, can you leave some suggestions? ;)
bascule:
--- Quote from: MarcGuay on June 29, 2008, 07:59:11 PM ---It's great to see other people getting keen on maintaining the documentation. Keep it up! There was a mention of a "documentation-binge week" at the DevCon which I'd love to see followed through on.
--- End quote ---
I would also like to see/participate in this.
--- Quote from: MarcGuay on June 29, 2008, 07:59:11 PM ---1) Move the Rockbox Museum stuff to it's own page, it's really just a pile of crap which might come in handy someday and therefore doesn't need to be easily accessed frequently through the DocsIndex.
--- End quote ---
A good idea. This (and the DocsIndex itself) could be done, almost automatically, using Wiki categories. I don't know if you looked into these when doing the clean-up, but if we re-categorised all the Wiki pages into more discrete groups, then the index pages just about write themselves.
For instance, the WebHome page mostly consists of these few searches to generate content:
--- Code: ---Some pages of interest:
---++ Documentation
* [[http://www.rockbox.org/manual.shtml][The Rockbox Manual]] - Get your copy here
%SEARCH{"^CategoryFrontpage:.*\[.*Documentation.*]" scope="text" regex="on" nototal="on" nosearch="on" format=" * [[$topic]] - $pattern(.*?CategoryFrontpage:([^\[]*).*)" }%
---++ Functional Ports
%SEARCH{"^CategoryFrontpage:.*\[Ports]" scope="text" regex="on" nototal="on" nosearch="on" format=" * [[$topic]] - $pattern(.*?CategoryFrontpage:([^\[]*).*)" }%
---++ New Ports
%SEARCH{"^CategoryFrontpage:.*\[New Ports]" scope="text" regex="on" nototal="on" nosearch="on" format=" * [[$topic]] - $pattern(.*?CategoryFrontpage:([^\[]*).*)" }%
---++ Miscellaneous
%SEARCH{"^CategoryFrontpage:.*\[.*Misc.*]" scope="text" regex="on" nototal="on" nosearch="on" format=" * [[$topic]] - $pattern(.*?CategoryFrontpage:([^\[]*).*)" }%
---
%INCLUDE{"RecentChanges"}%
--- End code ---
I still haven't figured out, though, what benefit the Parent/Child relationship between pages really has...
MarcGuay:
Strife: Sorry, no real suggestions. If I had a clue where to start I would have done it myself. :)
bascule: Yeah I looked at the categorization options but ended up just going with hard-coding because it would have taken even longer to do and the wiki isn't really complex enough to warrant it, in my opinion.
Zardoz:
It would be nice if the wiki front page included a prominent (perhaps toward-top, centred, larger-fonted) 'Search the Wiki' option box/field. A lot of information on the wiki is referenced in the forums and it can be wiki-tricky (sorry) to unearth it. Maybe it's a 'dumbing down' kinda suggestion but I can't see it interfering with the functionality of the site and it might make it easier for semi-casual users, like me ;) to find additional information which might ultimately reduce the forum headaches for you guys? (Personally I'd reconfigure the box at top right to simply use wikiwords only, for those who know them.) If this has been covered already or i'm missing something really obvious i'm sorry!)
Navigation
[0] Message Index
[#] Next page
[*] Previous page
Go to full version