Fixed #17933 -- Added intro note to writing-documentation.txt

Based on initial patch by Thomas Westfeld
This commit is contained in:
Adrian Holovaty 2012-06-07 11:32:28 -05:00
parent 4a103086d5
commit 87ff89d12d
1 changed files with 16 additions and 0 deletions

View File

@ -18,6 +18,22 @@ Documentation changes generally come in two forms:
This section explains how writers can craft their documentation changes This section explains how writers can craft their documentation changes
in the most useful and least error-prone ways. in the most useful and least error-prone ways.
Getting the raw documentation
-----------------------------
Though Django's documentation is intended to be read as HTML at
http://docs.djangoproject.com/, we edit it as a collection of text files for
maximum flexibility. These files live in the top-level ``docs/`` directory of a
Django release.
If you'd like to start contributing to our docs, get the development version of
Django from the source code repository
(see :ref:`installing-development-version`). The development version has the
latest-and-greatest documentation, just as it has latest-and-greatest code.
Generally, we only revise documentation in the development version, as our
policy is to freeze documentation for existing releases (see
:ref:`differences-between-doc-versions`).
Getting started with Sphinx Getting started with Sphinx
--------------------------- ---------------------------