> -----Ursprüngliche Nachricht----- > Von: thron7 [mailto:[email protected]] > Gesendet: Mittwoch, 17. April 2013 11:04 > An: qooxdoo Development > Betreff: Re: [qooxdoo-devel] Questions & Wrong information on the website > > On 04/17/2013 09:20 AM, tedi tedi wrote: > > I wanted to create a documentation for my package, just to make the > warning go away, so I found this page: > http://manual.qooxdoo.org/1.3/pages/development/write_api_documentation > .html > > There's something wrong with it: > At section "__init__.js Files" you say: "In order to fill this gap you > can > add a __init.js__ file to a package.". The file I had to create was a .js > file, not a > .js__ file. So please update the sentence to "In order to fill this gap you > can add > a __init__.js file to a package.", since the filename in the section title is > the > correct one.
I do think this criticism is valid for some points: I too have often stumbled upon old versions of documentation pages when googling. Sometimes (as is the case with removed or renamed pages) simply updating the version in the URL just throws you back at the root (for example when changing the 1.2 in manual.qooxdoo.org/1.2/pages/development/variants.html to 2.1, I get redirected to http://qooxdoo.org/docs, which is not very helpful and will fail to inform me of the fact that variants have been removed [the 1.4 version would inform me of that but how would I know this beforehand?]). It could be very helpful to either have a more intelligent redirection mechanism, a canonical <link> tag (to nudge search engines to the latest version of a documentation page), or a switcher on each page to help the user to select the correct version. ------------------------------------------------------------------------------ Precog is a next-generation analytics platform capable of advanced analytics on semi-structured data. The platform includes APIs for building apps and a phenomenal toolset for data science. Developers can use our toolset for easy data analysis & visualization. Get a free account! http://www2.precog.com/precogplatform/slashdotnewsletter _______________________________________________ qooxdoo-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/qooxdoo-devel
