@restlet.tigris.org
Objet : Re: [docs] Poll for participation and input.
On Tuesday 09 October 2007 21:52:17 Jerome Louvel wrote:
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
On Tuesday 09 October 2007 21:52:17 Jerome Louvel wrote:
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
also a maven section with
Sean Landis sean.landis at gmail.com writes:
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).
I agree with this as long as the feature descriptions are very detailed.
I think a
Jerome Louvel contact at noelios.com writes:
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
Some of my TOC additions embedded, feel free to comment...
(incorporated the suggestions from issue 21 and those made in this
thread already)
I also added a big section on doing reslet based development as I think
there is a big difference in listing 'what it is and does' versus 'how
one
Marc Portier mpo at outerthought.org writes:
Some of my TOC additions embedded, feel free to comment...
(incorporated the suggestions from issue 21 and those made in this
thread already)
I also added a big section on doing reslet based development as I think
there is a big difference
Just two requests:
- Also include the option for other developers to add (and change)
stuff. For example, Tapestry has many great HowTo chapters written by other
developers (see here: http://wiki.apache.org/tapestry/Tapestry5HowTos).
And it would be beneficial when the examples in the
Hi Erik,
* Also include the option for other developers to add
(and change) stuff.
The Wiki will facilitate external contributions. Only a simple online
registration will be needed with a one-click JCA agreement page.
In the end, we hope to have many more doc authors than developers
Hi Sean,
I am a little confused. Are you proposing these two as alternatives,
or are you proposing both a reference and a book?
I was just pointing to two interesting documentation efforts that we could
get inspiration from.
The collaborative tool used for Django looks interesting. Or is
Hi Marc,
looks like a great TOC to get started, if we can agree here on a
derivative version for restlet, then I'll be glad to enter
that into the system as a first draft...
Here is a draft TOC to start with :)
1. Introduction
1.1. Overview
1.2. Usage scenarios
2. What's new in
Jerome Louvel contact at noelios.com writes:
Hi Sean,
Thanks for proposing to give a hand.
Also, I'd like to share again the links in Marc's email as they didn't get
recognized in my email client:
[1] http://restlet.tigris.org/servlets/ReadMsg?listName=discussmsgNo=3063
[2]
Landis
Envoyé : mardi 2 octobre 2007 16:54
À : discuss@restlet.tigris.org
Objet : Re: [docs] Poll for participation and input.
Marc Portier mpo at outerthought.org writes:
Hi all,
as an outcome of the recent thread on creating a 'developer
guide' (see
[1]) Rob, Jerome and me
12 matches
Mail list logo