strand-braid-user: update docs

strawlab · Dec 14, 2023 · a891386 · a891386
1 parent 3146acb
commit a891386
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 3 deletions.
diff --git a/strand-braid-user/users-guide/README.md b/strand-braid-user/users-guide/README.md
@@ -1,4 +1,7 @@
-# User's Guide
+# Braid and Strand Camera User's Guide
+
+This is the source of the *Braid and Strand Camera User's Guide*, which is
+visible [here](https://strawlab.github.io/strand-braid/).
 
 ## Building
 
@@ -8,13 +11,15 @@ you can install this with `cargo install mdbook`.)
 
 Build the User's Guide website with the command:
 
+    # run from strand-braid-user/users-guide/
     mdbook build
 
 ## Development
 
 You can develop the users guide with the command:
 
-    mdbook serve users-guide --open
+    # run from strand-braid-user/users-guide/
+    mdbook serve --open
 
 This will then run a program which watches for changes, rebuilds the website when
 something changes, and hosts it. By default this is at http://localhost:3000/ .
diff --git a/strand-braid-user/users-guide/book.toml b/strand-braid-user/users-guide/book.toml
@@ -14,4 +14,4 @@ create-missing = false
 [output.html]
 # This is used for the 404 page
 site-url = "https://strawlab.github.io/strand-braid/"
-git-repository-url = "https://github.com/strawlab/strand-braid"
+git-repository-url = "https://github.com/strawlab/strand-braid/tree/main/strand-braid-user/users-guide"