From a2493baead14a1156a87ccf777a85c8b0512deb7 Mon Sep 17 00:00:00 2001
From: Rory Flynn <75283103+roaree@users.noreply.github.com>
Date: Tue, 14 Jan 2025 13:12:10 +0100
Subject: [PATCH] Documentation tweaks (#599)

* Adds link in install instructions to the command completion docs added in #597
* Small visual tweaks
---
 docs/command_completion.md | 12 +++++++++---
 docs/install.md            |  4 ++++
 2 files changed, 13 insertions(+), 3 deletions(-)

diff --git a/docs/command_completion.md b/docs/command_completion.md
index 643dea3ce..1cd4eb75e 100644
--- a/docs/command_completion.md
+++ b/docs/command_completion.md
@@ -8,7 +8,7 @@ To enable it, you need to manually register a special function with your shell,
 
 The following describes how to generate the command completion scripts and add them to your shell configuration. 
 
-`You will need to start a new shell for the changes to take effect.`
+> **Note: You will need to start a new shell for the changes to take effect.**
 
 ### For Bash
 
@@ -16,8 +16,11 @@ The following describes how to generate the command completion scripts and add t
 # Generates bash completion scripts
 echo "$(_MVT_IOS_COMPLETE=bash_source mvt-ios)" > ~/.mvt-ios-complete.bash &&
 echo "$(_MVT_ANDROID_COMPLETE=bash_source mvt-android)" > ~/.mvt-android-complete.bash
+```
 
-# Sources the scripts in ~/.bashrc.
+Add the following to `~/.bashrc`:
+```bash
+# source mvt completion scripts
 . ~/.mvt-ios-complete.bash && .  ~/.mvt-android-complete.bash
 ```
 
@@ -27,8 +30,11 @@ echo "$(_MVT_ANDROID_COMPLETE=bash_source mvt-android)" > ~/.mvt-android-complet
 # Generates zsh completion scripts
 echo "$(_MVT_IOS_COMPLETE=zsh_source mvt-ios)" >  ~/.mvt-ios-complete.zsh &&
 echo "$(_MVT_ANDROID_COMPLETE=zsh_source mvt-android)" > ~/.mvt-android-complete.zsh
+```
 
-# Sources the scripts in ~/.zshrc.
+Add the following to `~/.zshrc`:
+```bash
+# source mvt completion scripts
 .  ~/.mvt-ios-complete.zsh  && .  ~/.mvt-android-complete.zsh
 ```
 
diff --git a/docs/install.md b/docs/install.md
index cf54cb427..c08c75dbd 100644
--- a/docs/install.md
+++ b/docs/install.md
@@ -98,3 +98,7 @@ You now should have the `mvt-ios` and `mvt-android` utilities installed.
 **Notes:**
 1. The `--force` flag is necessary to force the reinstallation of the package.
 2. To revert to using a PyPI version, it will be necessary to `pipx uninstall mvt` first.
+
+## Setting up command completions
+
+See ["Command completions"](command_completion.md)