summaryrefslogtreecommitdiffstats
path: root/docs/index.md
diff options
context:
space:
mode:
authorChristian Mollekopf <chrigi_1@fastmail.fm>2015-10-08 18:55:44 +0200
committerChristian Mollekopf <chrigi_1@fastmail.fm>2015-10-10 10:40:01 +0200
commitf269a33d74e76f61f969a661a9428a76ed8e626e (patch)
tree00c19d959940c906ee7a6ac8e746d706aded8846 /docs/index.md
parentc08ac164d20c56e4b2890ebc9f2acda2c5723b5c (diff)
downloadsink-f269a33d74e76f61f969a661a9428a76ed8e626e.tar.gz
sink-f269a33d74e76f61f969a661a9428a76ed8e626e.zip
Initial set of documentation, still WIP
Diffstat (limited to 'docs/index.md')
-rw-r--r--docs/index.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/index.md b/docs/index.md
new file mode 100644
index 0000000..3019cfd
--- /dev/null
+++ b/docs/index.md
@@ -0,0 +1,17 @@
1# Index
2* Design
3 * Design Goals
4 * Overview
5 * Client API
6 * Storage
7 * Resource
8 * Facade
9 * Logging
10* Extending Akoandi Next
11 * Steps to add support for new types
12 * Steps for adding support for a type to a resource
13
14# Documentation
15This documentation is built using [mkdocs.org](http://mkdocs.org).
16
17Use `mkdocs serve` to run a local webserver to view the docs.