|
|
@@ -180,6 +180,31 @@ There's a helper script for building the docs locally::
|
|
180
|
180
|
cd docs
|
|
181
|
181
|
./test_docs.sh
|
|
182
|
182
|
|
|
|
183
|
+The actual docs are in ``/docs/source``. This directory structure is a
|
|
|
184
|
+simplified version of what Django does.
|
|
|
185
|
+
|
|
|
186
|
+* ``internals/`` contains everything related to Oscar itself, e.g. contributing
|
|
|
187
|
+ guidelines or design philosophies.
|
|
|
188
|
+* ``ref/`` is the reference documentation, esp. consisting of
|
|
|
189
|
+* ``ref/apps/`` which should be a guide to each Oscar core app, explaining it's
|
|
|
190
|
+ function, the main models, how it relates to the other apps, etc.
|
|
|
191
|
+* ``topics/`` will contain "meta" articles, explaining how things tie together
|
|
|
192
|
+ over several apps, or how Oscar can be combined with other solutions.
|
|
|
193
|
+* ``howto/`` contains tutorial-style descriptions on how to solve a certain
|
|
|
194
|
+ problem. Ideally, those will be kept to a minimum; as the other docs should
|
|
|
195
|
+ be understandable enough that necessary steps to achieve a certain goal are
|
|
|
196
|
+ obvious.
|
|
|
197
|
+* ``_old/`` contains legacy documents that have not been moved into the new
|
|
|
198
|
+ structure. Please help get rid of those!
|
|
|
199
|
+
|
|
|
200
|
+``/index.rst`` is designed as the entry point, and diverges from above
|
|
|
201
|
+structure to make the documentation more approachable. Other ``index.rst``
|
|
|
202
|
+files should only be created if there's too many files to list them all.
|
|
|
203
|
+E.g. ``/index.rst`` directly links to all files in ``topics/`` and
|
|
|
204
|
+``internals/``, but there's an ``index.rst`` both for the files in ``howto/``
|
|
|
205
|
+and ``ref/apps/``.
|
|
|
206
|
+
|
|
|
207
|
+
|
|
183
|
208
|
Conventions
|
|
184
|
209
|
===========
|
|
185
|
210
|
|