Document baseurl and change to a useful default.

[arvados.git] / doc / _config.yml

diff --git a/doc/_config.yml b/doc/_config.yml
index 3e40c589d54fa42310f1d687cf2a2d6aad193920..9b80a96b9139db13fd36f8ce3934d50c6db5c4b0 100644 (file)
--- a/doc/_config.yml
+++ b/doc/_config.yml
@@ -1,5 +1,12 @@
-exclude: ["Rakefile", "tmp", "vendor"]
+# baseurl is the location of the generated site from the browser's
+# perspective (e.g., http://doc.arvados.org or
+# file:///tmp/arvados/doc/.site). To make docs show up inside
+# workbench, use /doc here and add a symlink at
+# apps/workbench/public/doc pointing to ../../../doc/.site
+
 baseurl: /doc
+
+exclude: ["Rakefile", "tmp", "vendor"]
 arvados_api_host: qr1hi.arvadosapi.com
 
 navbar: