docs(serve): update to documentation, add serve.md to mkdocs.yaml

compbiocore · Jan 4, 2019 · b46da89 · b46da89
1 parent d7fa0dc
commit b46da89
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/docs/serve.md b/docs/serve.md
@@ -1,4 +1,4 @@
-RefChef comes with the `refchef-serve` script. It takes the argument `--master (-m)` or `--config -c` to find the local `master.yaml` file. RefChef serve will render a web interface with a filterable table containing all references, indices, and annotations downloaded to the local system.
+RefChef comes with the `refchef-serve` script. RefChef Serve uses Flask to create a minimal web interface with a list of references downloaded to the local system. It takes the argument `--master (-m)` or `--config -c` to find the local `master.yaml` file. RefChef serve will render a web interface with a filterable table containing all references, indices, and annotations.
 
 Currently, the table shows only the following fields: reference name, species, organization, component, location of files, files, and UUID.
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -28,3 +28,4 @@ nav:
   - Home: 'index.md'
   - Installation: 'installation.md'
   - Usage: 'usage.md'
+  - RefChef serve: 'serve.md'