aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorIlya Ryzhenkov <orangy@jetbrains.com>2014-07-14 23:58:18 +0400
committerIlya Ryzhenkov <orangy@jetbrains.com>2014-07-14 23:58:18 +0400
commitad884a9ce79f191f3a7b7aed115080e341265ef3 (patch)
tree08fb3ca6cdba8e15184a0b18f1392be6b6200150 /README.md
parente22c075c6668d99fed83b5cb783a8533d5dbdacd (diff)
downloaddokka-ad884a9ce79f191f3a7b7aed115080e341265ef3.tar.gz
Link to samples and fixed typo.
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/README.md b/README.md
index 1073845cd..5e9c99493 100644
--- a/README.md
+++ b/README.md
@@ -19,7 +19,7 @@ Each reference between nodes also has semantic attached, and there are three of
2. Detail - reference means that target describes source in more details, form tree.
3. Link - any link to any other node, free form.
-Member & Detail has reverse Owner reference, while Link's reference is also Link.
+Member & Detail has reverse Owner reference, while Link's back reference is also Link.
Nodes that are Details of other nodes cannot have Members.
@@ -41,6 +41,10 @@ Basically, given the `documentation` as a model, we do this:
generator.generate(documentation)
```
+Samples
+====
+[Dokka docs](https://github.com/orangy/dokka/blob/gh-pages/doc/dokka/index.md) are built with Dokka. Yes, we bootstrap and dogfood :)
+
Roadmap
=====