docs(GITBOOK#179): Added 9 missing page descriptions

atsign-foundation · Jan 28, 2025 · 0b80660 · 0b80660
1 parent 098beca
commit 0b80660
Show file tree

Hide file tree

Showing 10 changed files with 37 additions and 11 deletions.
diff --git a/docs/installation/linux/full.md b/docs/installation/linux/full.md
@@ -1,3 +1,7 @@
+---
+description: Video and written directions
+---
+
 # Linux Full Installation
 
 {% include "../../.gitbook/includes/mac-linux-full-install-video.md" %}

diff --git a/docs/installation/macos/desktop.md b/docs/installation/macos/desktop.md
@@ -1,3 +1,7 @@
+---
+description: Video and written directions
+---
+
 # MacOS Desktop Client Installation
 
 {% embed url="https://vimeo.com/1038239765" %}

diff --git a/docs/installation/windows/desktop.md b/docs/installation/windows/desktop.md
@@ -1,3 +1,7 @@
+---
+description: Video and written directions
+---
+
 # Windows Desktop Client Installation
 
 {% embed url="https://vimeo.com/1038239765" %}

diff --git a/docs/reference/faq.md b/docs/reference/faq.md
@@ -1,5 +1,6 @@
 ---
 icon: comments-question-check
+description: Common questions about NoPorts
 ---
 
 # FAQ

diff --git a/docs/reference/how-it-works.md b/docs/reference/how-it-works.md
@@ -1,5 +1,6 @@
 ---
 icon: magnifying-glass
+description: NoPorts connection establishment and architecture
 ---
 
 # How It Works

diff --git a/docs/reference/policy.md b/docs/reference/policy.md
@@ -1,10 +1,14 @@
 ---
 icon: users-rectangle
+description: >-
+  A flexible suite of policy management tools. Use a standalone database to
+  store and manage policies using our administration interface, or integrate it
+  with your existing policy database or service.
 ---
 
 # NoPorts Policy Service
 
-The NoPorts Policy Service is a flexible suite of tools for managing policies. You can use a standalone database for storing and managing your policies using our administration interface, or you can integrate it with your existing policy database or service.&#x20;
+
 
 <figure><img src="../.gitbook/assets/NoPorts Policy Diagrams.png" alt=""><figcaption><p>High level overview of the NoPorts architecture</p></figcaption></figure>
 

diff --git a/docs/use-cases/rdp.md b/docs/use-cases/rdp.md
@@ -1,12 +1,15 @@
 ---
 icon: desktop
+description: >-
+  In this guide, we demonstrate how to use the NoPorts Tunnel to RDP on a remote
+  machine to localhost:3389 so we can access the RDP service locally.
 ---
 
 # RDP
 
-## Overview
 
-In this guide, we demonstrate how to use the NoPorts Tunnel to RDP on a remote machine to localhost:3389 so we can access the RDP service locally.
+
+
 
 The command should look like:
 

diff --git a/docs/use-cases/sftp.md b/docs/use-cases/sftp.md
@@ -1,11 +1,13 @@
 ---
 icon: folder-closed
+description: >-
+  In this guide, we demonstrate how to use the NoPorts Tunnel to bridge SFTP on
+  a remote machine to localhost:2222 so we can access it in an SFTP client
+  locally.
 ---
 
 # SFTP
 
-In this guide, we demonstrate how to use the NoPorts Tunnel to bridge SFTP on a remote machine to localhost:2222 so we can access it in an SFTP client locally.
-
 \
 The command should look like:
 

diff --git a/docs/use-cases/smb.md b/docs/use-cases/smb.md
@@ -1,12 +1,14 @@
 ---
 icon: folder-tree
+description: >-
+  In this guide, we demonstrate how to use the NoPorts Tunnel to mount a SMB
+  share on a remote machine on 192.168.1.90 to localhost:9000 so we can access
+  the SMB share service locally.
 ---
 
 # SMB
 
-## Overview
 
-In this guide, we demonstrate how to use the NoPorts Tunnel to mount a SMB share on a remote machine on 192.168.1.90 to localhost:9000 so we can access the SMB share service locally.
 
 The command should look like:
 
@@ -32,8 +34,6 @@ Now you can mount the SMB share locally using the finder app ( Go->Connect to se
 
 Once mounted you can use the file share as normal, as you dismount the file share the NPT command will disconnect.
 
-
-
 {% hint style="info" %}
 Windows mounting on a non-standard port is currently not supported by Microsoft but they are working on it.
 

diff --git a/docs/use-cases/ssh.md b/docs/use-cases/ssh.md
@@ -1,12 +1,15 @@
 ---
 icon: rectangle-terminal
+description: >-
+  In this guide, we demonstrate how to use SSH NoPorts to SSH to a remote
+  machine.
 ---
 
 # SSH
 
-## Overview
 
-In this guide, we demonstrate how to use SSH NoPorts to SSH to a remote machine.
+
+
 
 The command should look like: