Rockbox General > Rockbox General Discussion

Wiki Cleanup

(1/4) > >>

MarcGuay:
As some of your may have noticed I've been sweeping through the wiki and trying to organize things a little bit.  It's a pretty important source of information and I found a lot of it was either out of date or just messy enough to make it hard to find what you were looking for.

So, a few weeks ago I dumped the entire index (minus the user pages, o' course) into a text file and started sorting them into categories.  What I ended up with at the end, in the "active and useful pages" section, are now available on the documentation index page and the main wiki page (or immediate sub-pages of those, in the case of, say, specific player hardware & bootloader information).

The following pages are sitting in the I have been added to the glossary and can probably be deleted category:

    * SoC (Simple terminology - Added to ProjectGlossary)
    * NiMH (Simple terminology - Added to ProjectGlossary)
    * LiIon (Simple terminology - Added to ProjectGlossary)
    * FlashMemory (Simple terminology - Added to ProjectGlossary)
    * MultiMediaCard (Simple terminology - Added to ProjectGlossary)
    * FileFormatMI4 (Simple terminology - Added to ProjectGlossary)

... and some runner's up in the I have been merged with other pages and could most likely be done with category:

    * IpodTips (merged with iPod FAQ)
    * OtherTargets (merged with TargetStatus)
    * MenuRework (dupe)
    * IriverH100FAQ & IriverH10FAQ & IriverH300FAQ - All merged into iriverFAQ  
    * ManualHowTo (merged with GeneralFAQ)

And now the fun part.   This is the somewhat unsorted, what am I?  am I really old or do I just look that way?  am I worth keeping in some kind of "historical" archive?  do my feet smell?  category:

    * BootBox - these two pages are very confusing to me
    * RomBox
    * RockboxDevelopment (simply points to cgwyn and crosscompile - needs rewrite or deletion)
    * FilesScreen ********for archos only, delete*********
    * IpodExperimental  
    * GUIProposal  *********dead******
    * ManualFileBrowser *old manual stuff*
    * WikiManual
    * ManualFileMenu
    * ManualMainMenu
    * PlaylistScreen
    * ManualRockboxInstall
    * RecordScreen
    * QuickMenu
    * TrackScreen
    * ManualWpsContextMenu
    * NonArchos
    * PluginScreen
    * RealLife ?
    * MissingAttachments
    * RockboxGraphicalUIDesign (some guy trying to change the boot logo?)
    * RadioScreen
    * QuickStart
    * PastedImagesForFourms (ancient thing, typo in name, hardly used)
    * WikiRestore (historical)
    * WebStatistics (neat if it was kept up to date)
    * WPSTokenbasedHandling
    * RockboxAudioAPIProposal
    * RootMenu (discussion of main menu design - old)
    * RuntimeDatabase (old discussion - pre Database)
    * TagDatabase
    * RockboxUserInterfaceProposal (archos)
    * RockboxFlash (empty page)
    * RockboxThemes (iRiver H100 - empty)
    * RockboxUtilityOld
    * RockboxUtilityQt (moved to RockboxUtility)
    * VideoCodecs (ancient, r1)
    * ThingsTodo (delete, points to->)
    * SourceForge (dead)
    * MediaCoder (link to a sourceforge project)
    * HarddiskInfo (dead, replaced by HardDriveReplacement)
    * ForumChanges (more old stuff, suggested forum changes?)
    * FlashingRockbox (old)
    * EncoderDiscussionMP3 (oldoldoldod)
    * DocBoxObsolete (ancient)
    * DesktopTools (installers - depricated by RockboxUtility)
    * ChangeLog25 (old, changes between 2.4 and 2.5)
    * BrokenSed (ancient)
    * ThemeRepository (discussing new themes site, dead?)
    * RockboxShots (kill - outdated)
    * IpodInstallation (dead)
    * IpodInstallationBeta
    * IpodInstallationFromLinux
    * IpodInstallationFromMacOSX
    * IpodMacOSInstaller (old dead external program)
    * IpodRestoration (iPod Unbrick?  Delete?)
    * IpodInstallationKr (depricated?)
    * SansaE200Install (killed)
    * SansaE200InstallBeta (killed)
    * SansaE200RBootloaderPatching (outdated)
    * KeymapOndio (depreciated)
    * RockBox251 (Archos build, depricated)
    * SanDisk (pointless?)
    * IaudioBoot (out of date?) info moved to iAudio port page
    * IaudioBootKr (out of date?)
    * IriverFAQKr (dead)
    * IriverInstall
    * IriverInstallKr
    * IriverPlaylistInstructions (not specific to iriver, should be in the manual? FAQ?)
    * IriverRecording (not specific to iriver)
    * IriverH10InstallationBeta (dead)
    * IriverTeam (old)
    * IriverTesting (dead)
    * IriverRamLoad (obsolete)
    * IriverNavigation (port navigation - killed)
    * CodecTesting
    * TriggerManual (delete after adding to the manual)
    * NewForumProposal (way old)
    * SortingPluginsProposal (old)
    * CompiledSkinProposal (ancient but...)
    * UseDisplayName (proposal, dead patch? archos only?)
    * SettingsRecode (abandonned project?/discussion?)
    * PowerConsumption (dead?  iriver only?)
    * FixingWaves (Rockbox ruins waves - out of date?)
    * DocumentViewer (project - dead?)
    * ColdfireEmulatorDevelopment (old, outdated?)
    * BufferingAPIProposal (MoB depreciated?)
    * MasLimitations (dead?)
    * FmTunerProject (iriver only---delete***** done?) seems to still need work, ask around?
    * SoapSealofApproval (old?)
    * AllKeysConfigurable (dead proposal?)
    * BookmarkUseCases
    * BrowseByAlphabet (dead)
    * ButtonActionIdea
    * ButtonAssignments (depricated by manual)
    * CustomMenus (very dead proposal)
    * SubmitWPS (no longer applicable)
    * MenuSettingsRecoding (done?)
    * MetadataOnBuffer
       * MetadataOnBufferTesting
    * ViewDrawing (proposal for new theme interface, inactive)
    * CuesheetSupport (committed)
    * ReleaseAnnouncement30 (old)
    * ShuffleExplained (old?)
    * FlySprayLinks (no longer needed because of links on left panel?)
    * SimpleGuideToCompilingKr (dead)
    * MisticRiver (why? UserForums mention is good enough)
    * OldPluginIndex (any point?)
    * OpenOffice (DELETE)
   *  RockBox (ummm?)  

and then the minor ToDo list:

    * BlindFAQ (Archos only, should be updated)
    * BlindFlashing (Archos only, should be updated)
    * BatteryFAQ (Archos only, should be updated?  or not worth it?)
    * Clean up the Gigabeat port index, specifically, are the installation instructions still necessary?

---

So, I guess what I'm saying is that I've reached both the end of my energy for this task and my knowledge of Rockbox, and could use some energetic and knowledgeable help to bring it to completion.  If anyone wants to go through the list of orphaned pages and decide whether they're worth keeping in the documentation index, deserve a proper but economical burial, or are worthy of a monument, that would be awesome.  And if anyone wants to stare that ToDo list in the face, that would be nice too.  

Otherwise, I'll continue to chip away at the wall as usual.

Marc

rasher:
As a general rule, I don't think you should delete old stuff just because it's outdated. Suddenly it turns out to be useful, and you know know what or when.

MarcGuay:
Also, there might still be links pointing to those pages, in which case it would be nice to not have users led into dead-ends.  I guess by "deleting" I mean "clear & redirect"; the wiki will keep the history if anyone's interested and needs to track it down.  

But in the meantime a lot of these pages are just cluttering things up and leading to a lot of avoidable support questions.  You can't blame the users for not understanding things if your documentation still contains an older, outdated copy of "the manual" which they're constantly being told to refer to.

pondlife:
I've long found that the wiki is too disorganised to find useful information quickly.  I realise that the history can be useful in some cases, but in many cases the out of date "information" might as well be called misinformation.  I applaud Marc's work.

Might it be practical to start a new wiki, with a clear, documented structure, then move good pages over into it.  The old wiki could be left alone (complete with out-of-date stuff), but relegated to a secondary URL - wikiarchive or similar.

pondlife

bascule:

--- Quote from: pondlife on February 12, 2008, 02:29:46 AM ---I've long found that the wiki is too disorganised to find useful information quickly.  I realise that the history can be useful in some cases, but in many cases the out of date "information" might as well be called misinformation.  I applaud Marc's work.
--- End quote ---
Absolutely


--- Quote from: pondlife on February 12, 2008, 02:29:46 AM ---Might it be practical to start a new wiki, with a clear, documented structure, then move good pages over into it.  The old wiki could be left alone (complete with out-of-date stuff), but relegated to a secondary URL - wikiarchive or similar.

--- End quote ---

Would it be sufficient just to have an 'archive' category that all such pages could be classified as, which would keep them within the main body of the Wiki, but allow them to be filtered out in the search engine?


--- Quote from: MarcGuay ---...If anyone wants to go through the list of orphaned pages and decide whether they're worth keeping in the documentation index, deserve a proper but economical burial, or are worthy of a monument, that would be awesome...
--- End quote ---

Is this the time (and it may well not be) to update the manual with the useful snippets of info in the Wiki and then delete the pages. I know when I first started using Rockbox that I found some little bits of info in the Wiki that were not in the manual about how specific things worked, or config options that are not well known.

Navigation

[0] Message Index

[#] Next page