> Hi all, > > I think the organization of the Slide docs could be improved for a forthcoming > release, with two main goals: > > 1. Clearly separate the documentation by it's intended target group: > > 1.1 Website: > Quick overview of the project, it's purpose, status, contributors, etc. > Quite a lot like it is today. > > 1.2 User's Guide > Move the user/administrator oriented documents into a self-contained > User's Guide (no need to make separation between users and administrators > here IMO). This would include installation/configuration instructions etc. > The website would have a single link to the User's Guide, instead of links > to every page of it (look at the Tomcat docs for an example).
+1. > 1.3 Developer's Guide > Again provide a self-contained bundle of documents and javadocs of the > various modules. Move the current website sections "Programmer's Corner" > and "Slide API" directly into the JavaDoc of the core API (using package > and overview files). Again the website would link to the entire Developer's > Guide instead of to every page of it. +1. > 2. Provide a well-printable version of the entire User's Guide (using a > different stylesheet for example). The left-side navigation screws up > most prints (I've even manually removed it in the past when I wanted > a hardcopy of the 'Slide API' section ;>). Even using a frameset is an > option here (see http://xml.apache.org/axis/). Yes, that's a good idea. It should be indeed doable with a new stylesheet. > I'd volunteer to help with 1.3 and 2 if we can agree that these goals are > desirable. I'm not really fit for writing new content, though. ;o) Remy
