(I bring this to the thread started by Martin, which is obviously more relevant)
>> I would prefer to have the documentation of the current stable version. >> Even better would of course be to have both, clearly distinguished >> (are they generated automatically, like by Maven?) > > The javadocs are. I agree with Martin's suggestion that it would be > really useful to have version-specific javadocs available online. > > The example pages on geotools.org are generated from 'hand written' > sphinx docs and at present we only have one (up to date) version of > those aligned to the development version. Hence the idea of keeping > them linked to 2.7 when it becomes the new stable version. In line with what Martin suggests, I think that: - it should be clearly stated that the current online docs are for the trunk / unstable - there should be "areas" on the website for each version (just as the the branches in the SVN repo), like 2.6.x, trunk, etc., and then you put whatever you have for a given branch (your javadocs are already much better and helpful than those of many projects) Documentation is always a challenge for open source projects, but we have the code so I would never dare to complain (in our organization, we produce an awful lot of open source code but we simply don't find the resources to document it, which makes it currently useless for any one else...). More generally (and as often) I would take example on the Spring Framework project: An overview: http://www.springsource.org/documentation 2.5.x branch: http://static.springsource.org/spring/docs/2.5.x/reference/index.html http://static.springsource.org/spring/docs/2.5.x/api/index.html 3.0.x branch: http://static.springsource.org/spring/docs/3.0.x/spring-framework-reference/html/ http://static.springsource.org/spring/docs/3.0.x/javadoc-api/ etc. ------------------------------------------------------------------------------ _______________________________________________ Geotools-gt2-users mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/geotools-gt2-users
