diff --git a/README.rst b/README.rst index 1e4430e2..6855135e 100644 --- a/README.rst +++ b/README.rst @@ -9,9 +9,10 @@ in Spotify's vast archive, manage playlists, and play music, you can use most platforms, including Windows, Mac OS X, Linux, and iPhone and Android phones. To install Mopidy, check out -`the installation docs `_. +`the installation docs `_. -* `Documentation `_ +* `Documentation `_ +* `Documentation (development version) `_ * `Source code `_ * `Issue tracker `_ * IRC: ``#mopidy`` at `irc.freenode.net `_ diff --git a/docs/development/contributing.rst b/docs/development/contributing.rst index a2ef4a15..eac94799 100644 --- a/docs/development/contributing.rst +++ b/docs/development/contributing.rst @@ -58,6 +58,8 @@ Code style Commit guidelines ================= +- We follow the development process described at http://nvie.com/git-model. + - Keep commits small and on topic. - If a commit looks too big you should be working in a feature branch not a @@ -107,8 +109,7 @@ Continuous integration server We run a continuous integration server called Hudson at http://hudson.mopidy.com/ that runs all test on multiple platforms (Ubuntu, OS -X, etc.) for every commit we push to GitHub. If the build is broken or fixed, -Hudson will issue notifications to our IRC channel. +X, etc.) for every commit we push to GitHub. In addition to running tests, Hudson also does coverage statistics and uses pylint to check for errors and possible improvements in our code. So, if you're @@ -135,9 +136,16 @@ Then, to generate docs:: .. note:: - The documentation at http://www.mopidy.com/docs/ is automatically updated - within 10 minutes after a documentation update is pushed to - ``jodal/mopidy/master`` at GitHub. + The documentation at http://www.mopidy.com/ is automatically updated when a + documentation update is pushed to ``jodal/mopidy`` at GitHub. + + Documentation generated from the ``master`` branch is published at + http://www.mopidy.com/docs/master/, and will always be valid for the latest + release. + + Documentation generated from the ``develop`` branch is published at + http://www.mopidy.com/docs/develop/, and will always be valid for the + latest development snapshot. Creating releases