From fe4c371001c0c9f1895e3ed6dea7506617b5e3cb Mon Sep 17 00:00:00 2001
From: Aldo Cortesi <aldo@corte.si>
Date: Tue, 15 May 2018 10:07:09 +1200
Subject: [PATCH] docs: split out tool documentation

---
 docs/src/content/_index.md                    |  3 ++
 .../{overview-tools.md => tools-mitmdump.md}  | 43 ++-----------------
 docs/src/content/tools-mitmproxy.md           | 18 ++++++++
 docs/src/content/tools-mitmweb.md             | 23 ++++++++++
 docs/src/layouts/partials/sidebar.html        |  3 ++
 5 files changed, 51 insertions(+), 39 deletions(-)
 rename docs/src/content/{overview-tools.md => tools-mitmdump.md} (57%)
 create mode 100644 docs/src/content/tools-mitmproxy.md
 create mode 100644 docs/src/content/tools-mitmweb.md

diff --git a/docs/src/content/_index.md b/docs/src/content/_index.md
index 44d41611e..cd368df0f 100644
--- a/docs/src/content/_index.md
+++ b/docs/src/content/_index.md
@@ -8,6 +8,9 @@ menu:
 
 # Introduction
 
+The mitmproxy project's tools are a set of front-ends that expose common
+underlying functionality.
+
 **mitmproxy** is an interactive man-in-the-middle proxy for HTTP and HTTPS
 with a console interface.
 
diff --git a/docs/src/content/overview-tools.md b/docs/src/content/tools-mitmdump.md
similarity index 57%
rename from docs/src/content/overview-tools.md
rename to docs/src/content/tools-mitmdump.md
index 0200e899c..fb6a6c0c7 100644
--- a/docs/src/content/overview-tools.md
+++ b/docs/src/content/tools-mitmdump.md
@@ -1,46 +1,11 @@
 ---
-title: "Tools"
-menu: "overview"
+title: "mitmdump"
+menu: "tools"
 menu:
-    overview:
-        weight: 3
+    tools:
+        weight: 2
 ---
 
-# Overview
-
-You should think of the mitmproxy project's tools as a set of front-ends that
-expose the same underlying functionality. We aim to have feature parity across
-all of our tooling, and all tools share a common configuration mechanism and
-most command-line options.
-
-## mitmproxy
-
-{{< figure src="/screenshots/mitmproxy.png" >}}
-
-**mitmproxy** is a console tool that allows interactive examination and
-modification of HTTP traffic. It differs from mitmdump in that all flows are
-kept in memory, which means that it's intended for taking and manipulating
-small-ish samples. Use the `?` shortcut key to view, context-sensitive
-documentation from any **mitmproxy** screen.
-
-
-## mitmweb
-
-{{< figure src="/screenshots/mitmweb.png" >}}
-
-**mitmweb** is mitmproxy's web-based user interface that allows
-interactive examination and modification of HTTP traffic. Like
-mitmproxy, it differs from mitmdump in that all flows are kept in
-memory, which means that it's intended for taking and manipulating
-small-ish samples.
-
-{{% note %}}
-Mitmweb is currently in beta. We consider it stable for all features
-currently exposed in the UI, but it still misses a lot of mitmproxy's
-features.
-{{% /note %}}
-
-
 ## mitmdump
 
 **mitmdump** is the command-line companion to mitmproxy. It provides
diff --git a/docs/src/content/tools-mitmproxy.md b/docs/src/content/tools-mitmproxy.md
new file mode 100644
index 000000000..6505fac48
--- /dev/null
+++ b/docs/src/content/tools-mitmproxy.md
@@ -0,0 +1,18 @@
+---
+title: "mitmproxy"
+menu: "tools"
+menu:
+    tools:
+        weight: 1
+---
+
+## mitmproxy
+
+{{< figure src="/screenshots/mitmproxy.png" >}}
+
+**mitmproxy** is a console tool that allows interactive examination and
+modification of HTTP traffic. It differs from mitmdump in that all flows are
+kept in memory, which means that it's intended for taking and manipulating
+small-ish samples. Use the `?` shortcut key to view, context-sensitive
+documentation from any **mitmproxy** screen.
+
diff --git a/docs/src/content/tools-mitmweb.md b/docs/src/content/tools-mitmweb.md
new file mode 100644
index 000000000..a3205377a
--- /dev/null
+++ b/docs/src/content/tools-mitmweb.md
@@ -0,0 +1,23 @@
+---
+title: "mitmweb"
+menu: "tools"
+menu:
+    tools:
+        weight: 3
+---
+
+## mitmweb
+
+{{< figure src="/screenshots/mitmweb.png" >}}
+
+**mitmweb** is mitmproxy's web-based user interface that allows
+interactive examination and modification of HTTP traffic. Like
+mitmproxy, it differs from mitmdump in that all flows are kept in
+memory, which means that it's intended for taking and manipulating
+small-ish samples.
+
+{{% note %}}
+Mitmweb is currently in beta. We consider it stable for all features
+currently exposed in the UI, but it still misses a lot of mitmproxy's
+features.
+{{% /note %}}
diff --git a/docs/src/layouts/partials/sidebar.html b/docs/src/layouts/partials/sidebar.html
index 5ea41c122..2dbec23af 100644
--- a/docs/src/layouts/partials/sidebar.html
+++ b/docs/src/layouts/partials/sidebar.html
@@ -8,6 +8,9 @@
     <p class="menu-label"> Overview </p>
     {{ partial "sidemenu" (dict "ctx" . "menuname" "overview") }}
 
+    <p class="menu-label">Tools</p>
+    {{ partial "sidemenu" (dict "ctx" . "menuname" "tools") }}
+
     <p class="menu-label">Core concepts</p>
     {{ partial "sidemenu" (dict "ctx" . "menuname" "concepts") }}