>
> >> Regarding the docs, it would be great if the docs on the Website
> >> are managed by Version (just like on the Django Website).
> >> That would allow everyone to prepare the docs for upcoming releases.
> >
> > Thats a good point.
> > How about having docs at docs/$version?
>
> I vote aye.
>

My suggestion for the doc versioning hierarchy would be to branch modules &
methods while updating their descriptions with deprecations and/or changes.
The resulting doc namespace could look something like this:

/
doc/
book
ref/
abridged
db
db/
...
query
#.3
#.22
#.21
select
update
...
forms
utils
utils/
...
dateify
numify
storify
...

borrowed from Python's docs (note the change mentioned for Try:
functionality in Python 2.5; http://docs.python.org/ref/try.html)

`/doc/ref/abridged` would be the current doc page. `/doc/ref/db` would be a
summary page with link for direct download of module, link for browsing
source code directly, a short summary, a list of supported DBMSes, the
methods found within, etc. `/doc/book` would be a table of contents for a
readable walkthrough of web.py. I believe Anand mentioned wanting a book of
some sort. Branching into `/doc/ref` allows for the book to contain
non-referential material maintained within the wiki that are sure not to
have a name conflict. Examples would be tutorials or common idioms.

Let me know what you guys think. I'll do the grunt work if this reaches
consensus.

Angelo

On 9/23/07, bubblboy <[EMAIL PROTECTED]> wrote:
>
>
> Anand wrote:
> >> Regarding the docs, it would be great if the docs on the Website
> >> are managed by Version (just like on the Django Website).
> >> That would allow everyone to prepare the docs for upcoming releases.
> >
> > Thats a good point.
> > How about having docs at docs/$version?
>
> I vote aye.
>
> >
>

--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups 
"web.py" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to [EMAIL PROTECTED]
For more options, visit this group at http://groups.google.com/group/webpy?hl=en
-~----------~----~----~----~------~----~------~--~---

Reply via email to