mdbook

.gitignore

@@ -1,2 +1,3 @@
+/book
 /target
 .DS_Store

README.md

@@ -6,6 +6,18 @@
 
 Software Defined Networking
 
+## Documentation
+
+Serve docs locally from root of local clone of this repo:
+
+```zsh
+cargo install mdbook@0.4.40
+```
+
+```zsh
+mdbook watch --open
+```
+
 ## git repo URLs
 
 - Main repo: https://git.nstr.no/nstr-sw/sdn

book.toml

@@ -0,0 +1,6 @@
+[book]
+authors = ["Nstr Software AS"]
+language = "en"
+multilingual = false
+src = "docs"
+title = "SDN"

docs/SUMMARY.md

@@ -0,0 +1,5 @@
+# Summary
+
+[Introduction](intro.md)
+
+- [Commands](commands.md)

docs/commands.md

@@ -0,0 +1,13 @@
+# Commands
+
+The following commands are available:
+
+- [`sdn`](#sdn)
+
+## sdn
+
+The main binary is called `sdn`.
+
+```zsh
+cargo run --bin sdn --
+```

docs/intro.md

@@ -0,0 +1,3 @@
+# Introduction
+
+Software Defined Networking