Преглед изворни кода

Some more improvements on the docs readme. Removed references to website.

Thatcher пре 12 година
родитељ
комит
ad3b091d53
1 измењених фајлова са 7 додато и 12 уклоњено
  1. 7 12
      docs/README.md

+ 7 - 12
docs/README.md

@@ -1,14 +1,12 @@
-Docker documentation and website
-================================
+Docker Documentation
+====================
 
 Documentation
 -------------
-This is your definite place to contribute to the docker documentation. The documentation is generated from the
-.rst files under sources.
-
-The folder also contains the other files to create the http://docker.io website, but you can generally ignore
-most of those.
+This is your definite place to contribute to the docker documentation. After each push to master the documentation
+is automatically generated and made available on [docs.docker.io](http://docs.docker.io)
 
+Each of the .rst files under sources reflects a page on the documentation. 
 
 Installation
 ------------
@@ -36,13 +34,11 @@ Images
 ------
 When you need to add images, try to make them as small as possible (e.g. as gif).
 
-
 Notes
 -----
 * For the template the css is compiled from less. When changes are needed they can be compiled using
 lessc ``lessc main.less`` or watched using watch-lessc ``watch-lessc -i main.less -o main.css``
 
-
 Guides on using sphinx
 ----------------------
 * To make links to certain pages create a link target like so:
@@ -77,9 +73,8 @@ Guides on using sphinx
 Manpages
 --------
 
-* To make the manpages, simply run 'make man'. Pleae note there is a bug in spinx 1.1.3 which makes this fail.
+* To make the manpages, simply run 'make man'. Please note there is a bug in spinx 1.1.3 which makes this fail.
 Upgrade to the latest version of sphinx.
 * Then preview the manpage by running `man _build/man/docker.1`, where _build/man/docker.1 is the path to the generated
 manfile
-
-The manpages are also autogenerated by our hosted readthedocs here: http://docs-docker.dotcloud.com/projects/docker/downloads/
+* The manpages are also autogenerated by our hosted readthedocs here: http://docs-docker.dotcloud.com/projects/docker/downloads/