On Wed 01 Apr 2009 15:10, Bertrand Delacretaz <[email protected]> wrote:
> I think it would be very hard to keep things in sync between svn and
> the wiki, once our bundles have independent release cycles. Call me
> pessimistic but I don't think we'd manage.
>
> We can still use the wiki for general/overview docs (though that might
> also be an "overview" bundle with just docs), and use the bundle-based
> docs for the reference stuff.
JavaDocs and other "official" API docs should definitely be versioned
and multiple versions should be available. Where they are matters less
than whether they exist at all.
Ideally, the website has multiple sections. Certain introduction
material doesn't need replicated for each version. It can just be
updated. But anything that specifically refers to code, such as
tutorials, should ideally be available in different versions.
Whether the wiki supports this setup or not is a different question from
how the documentation should ideally be organized.
--
J Aaron Farr jadetower.com [US] +1 724-964-4515
馮傑仁 cubiclemuses.com [HK] +852 8123-7905
