aboutsummaryrefslogtreecommitdiffstats
path: root/docs/index.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/index.md')
-rw-r--r--docs/index.md62
1 files changed, 62 insertions, 0 deletions
diff --git a/docs/index.md b/docs/index.md
new file mode 100644
index 00000000..9bd90d8d
--- /dev/null
+++ b/docs/index.md
@@ -0,0 +1,62 @@
+Quickstart
+==========
+
+**TODO**
+
+Tutorial
+========
+
+* [1 - Serialization][tut-1]
+* [2 - Requests & Responses][tut-2]
+* [3 - Class based views][tut-3]
+* [4 - Authentication, permissions & throttling][tut-4]
+* [5 - Relationships & hyperlinked APIs][tut-5]
+* [6 - Resource orientated projects][tut-6]
+
+API Guide
+=========
+
+* [Requests][request]
+* [Responses][response]
+* [Views][views]
+* [Parsers][parsers]
+* [Renderers][renderers]
+* [Serializers][serializers]
+* [Authentication][authentication]
+* [Permissions][permissions]
+* [Status codes][status]
+
+Topics
+======
+
+* [Returning URLs][urls]
+* [CSRF][csrf]
+* [Form overloading][formoverloading]
+
+Other
+=====
+
+* Why REST framework
+* Contributing
+* Change Log
+
+[tut-1]: tutorial/1-serialization.md
+[tut-2]: tutorial/2-requests-and-responses.md
+[tut-3]: tutorial/3-class-based-views.md
+[tut-4]: tutorial/4-authentication-permissions-and-throttling.md
+[tut-5]: tutorial/5-relationships-and-hyperlinked-apis.md
+[tut-6]: tutorial/6-resource-orientated-projects.md
+
+[request]: request.md
+[response]: response.md
+[views]: views.md
+[parsers]: parsers.md
+[renderers]: renderers.md
+[serializers]: serializers.md
+[authentication]: authentication.md
+[permissions]: permissions.md
+[status]: status.md
+
+[urls]: urls.md
+[csrf]: csrf.md
+[formoverloading]: formoverloading.md