Hi all, I agree that the reference manual shouldn't be a repeating of the Javadocs but go beyond and around them: - explain design choices - describe usage contexts - show sample code to copy and paste
IMO, it is not intended to be read in one shot like a book but more feature by feature depending on the user needs (beside the first introductory chapters). Also, I think we should reintegrate some pages from the current web site, see for example: http://www.restlet.org/documentation/1.0/ - Tutorial -> keep outside - Connectors -> merge with reference manual - Integrations -> merge with reference manual - Javadocs * -> keep outside - Examples -> merge with reference manual - Developer FAQ -> not sure... - Benchmark -> keep outside - Glossary -> merge with reference manual As for the 1.1 Javadoc, we'll put them up on the web site when we release 1.1 M1 sometimes soon. Best regards, Jerome > -----Message d'origine----- > De : Marc Portier [mailto:[EMAIL PROTECTED] De la part > de Marc Portier > Envoyé : mardi 9 octobre 2007 11:49 > À : [email protected] > Objet : Re: [docs] Poll for participation and input. > > Marc Portier wrote: > > [...] > > > As mentioned earlier we can introduce a "javadoc:" linking > convention in > > Daisy that should provide a way to avoid the 'repeating > ourselves' by > > inserting direct pointers to the apidocs. > > > > Thinking about providing that javadoc: linking feature... > > Jerome, > > I noticed the 1.1 javadoc is not up yet: > http://www.restlet.org/documentation/1.1/api/ > > I suppose you typically wait for the release to be ready before > publishing those? > > However I think we need to be able to let the docs in progress (about > the version in progress) link to regular re-published apidocs. > > wdyt? > > regards, > -marc=
