kallithea documentation and references to version numbers

[Mads Kiilerich]

On 01/14/2015 09:14 AM, Thomas De Schampheleire wrote:
> Other problems are duplication/conflicts between the wiki and the 
> documentation, for example there is a contributing section on both of 
> them, but the contents are different: 
> https://bitbucket.org/conservancy/kallithea/wiki/Home 
> http://kallithea.readthedocs.org/en/latest/contributing.html We should 
> decide one location for such information, and keep only that. Do you 
> have a preference?

I think most of it should be on the contributing page. The other one was 
a quick draft we made early in the process, but it seems to be somewhat 
useful and quite stable.

Some parts do however not belong in the documentation - for example the 
outdated "could be done" list.

> The advantage of the in-tree documentation which is on readthedocs
> too, is that it is also available off-line for users that have the
> repo.
> But is readthedocs updated with the tip, or with the latest revision?

We don't have hooks in place to update it on every commit. But I guess 
it is ok to just have the documentation for the released version there.

Andrew also had some thoughts/plans on where the documentation should live.

/Mads