X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/46f47b1e941e1471363a5d5480dbe4c68c18703a..3acd32f8a766269e0d7841000eb58e6d8364fcc9:/doc/README.textile

diff --git a/doc/README.textile b/doc/README.textile
index 23a82fe5b1..38a53cf7a2 100644
--- a/doc/README.textile
+++ b/doc/README.textile
@@ -18,6 +18,23 @@ h2. 1. Generate HTML pages
 arvados/doc$ rake
 </pre>
 
+Alternately, to make the documentation browsable on the local filesystem:
+
+<pre>
+arvados/doc$ rake generate baseurl=$PWD/.site
+</pre>
+
+h2. 2. Run linkchecker
+
+If you have "Linkchecker":http://wummel.github.io/linkchecker/ installed on
+your system, you can run it against the documentation:
+
+<pre>
+arvados/doc$ rake linkchecker baseurl=$PWD/.site
+</pre>
+
+Please note that this will regenerate your $PWD/.site directory.
+
 h2. 2. Preview HTML pages
 
 <pre>