experimenting with github pages

idaholab · Sep 23, 2022 · e6f4471 · e6f4471
1 parent f70fd95
commit e6f4471
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 1 deletion.
diff --git a/docs/README.md b/docs/README.md
@@ -22,7 +22,7 @@ For smaller networks, use at home by network security enthusiasts, or in the fie
 * [Development](development.md#Development)
     * [Building from source](development.md#Build)
     * [Pre-Packaged installation files](development.md#Packager)
-* Preparing your system
+* [Configuration](malcolm-preparation.md#Configuration)
     * [Recommended system requirements](system-requirements.md#SystemRequirements)
     * [Malcolm Configuration](malcolm-config.md#ConfigAndTuning)
         * [`docker-compose.yml` parameters](malcolm-config.md#DockerComposeYml)

diff --git a/docs/development.md b/docs/development.md
@@ -1,5 +1,9 @@
 ## <a name="Development"></a>Development
 
+* [Development](#Development)
+    * [Building from source](#Build)
+    * [Pre-Packaged installation files](#Packager)
+
 Checking out the [Malcolm source code](https://github.com/idaholab/Malcolm/tree/main) results in the following subdirectories in your `malcolm/` working copy:
 
 * `api` - code and configuration for the `api` container which provides a REST API to query Malcolm

diff --git a/docs/malcolm-preparation.md b/docs/malcolm-preparation.md
@@ -0,0 +1,10 @@
+### <a name="Configuration"></a>Configuration
+
+* [Configuration](#Configuration)
+    * [Recommended system requirements](system-requirements.md#SystemRequirements)
+    * [Malcolm Configuration](malcolm-config.md#ConfigAndTuning)
+        * [`docker-compose.yml` parameters](malcolm-config.md#DockerComposeYml)
+    * [Platform-specific Configuration](host-config.md#HostSystemConfig)
+        * [Linux host system configuration](host-config-linux.md#HostSystemConfigLinux)
+        * [macOS host system configuration](host-config-macos.md#HostSystemConfigMac)
+        * [Windows host system configuration](host-config-windows.md#HostSystemConfigWindows)
diff --git a/docs/quickstart.md b/docs/quickstart.md
@@ -1,5 +1,9 @@
 ## <a name="QuickStart"></a>Quick start
 
+* [Quick start](#QuickStart)
+    * [Getting Malcolm](#GetMalcolm)
+    * [User interface](#UserInterfaceURLs)
+
 ### <a name="GetMalcolm"></a>Getting Malcolm
 
 For a `TL;DR` example of downloading, configuring, and running Malcolm on a Linux platform, see [Installation example using Ubuntu 22.04 LTS](ubuntu-install-example.md#InstallationExample).