fix docs

interrogator · Aug 17, 2019 · a0b1c9b · a0b1c9b
1 parent d6b7ad3
commit a0b1c9b
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 8 deletions.
diff --git a/docs/about.md b/docs/about.md
@@ -1,3 +1,3 @@
-# About `buzzword`
+# About *buzzword*
 
-`buzzword` is completely open-sourced. It is designed to fill in the gap between corpus and computational linguistics. The tool helps address the lack of graphical interfaces for working with parsed and structured corpora.
+*buzzword* is an open-source frontend for *buzz*, a Python library for creating and analysing linguistic corpora.
diff --git a/docs/about_buzzword.md b/docs/about_buzzword.md
diff --git a/docs/buzzword.md → docs/guide.md b/docs/buzzword.md → docs/guide.md
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,7 @@
+`buzzword` is a web-app for linguistics, build on the [buzz](https://github.com/interrogator/buzz) backend.
+
+- [User guide](guide.md)
+- [Building corpora](building.md)
+- [Writing depgrep queries](depgrep.md)
+- [Running your own buzzword](run.md)
+- [About](about.md)
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -4,9 +4,9 @@ theme:
     name: readthedocs
 
 nav:
-    - Building high-quality corpora: buzzword.md
-    - Writing depgrep queries: buzzword.md
     - User guide: buzzword.md
-    - Running or serving buzzword: buzzword.md
+    - Building corpora: buzzword.md
+    - Writing depgrep queries: buzzword.md
+    - Running your own buzzword: buzzword.md
     - About: about.md