Skip to content

Commit

Permalink
docs(GITBOOK#4): Overhaul
Browse files Browse the repository at this point in the history
  • Loading branch information
XavierChanth authored and gitbook-bot committed Jan 5, 2024
1 parent 81abe54 commit 891022f
Show file tree
Hide file tree
Showing 7 changed files with 42 additions and 280 deletions.
24 changes: 23 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,23 @@
# Welcome to the Technical Documentation for SSH No Ports
# No Ports Docs

Welcome to the No Ports documentation site.



### SSH No Ports Overview

If you would like to learn more about SSH No Ports, how to install it, or how to use it, see the overview:

{% content-ref url="ssh-no-ports/overview.md" %}
[overview.md](ssh-no-ports/overview.md)
{% endcontent-ref %}



### Learn More about No Ports

If you would like to learn more about how everything works, see our developer notes section.

{% content-ref url="broken-reference" %}
[Broken link](broken-reference)
{% endcontent-ref %}
14 changes: 11 additions & 3 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# Table of contents

* [Home](README.md)
* [How Installation Works](howinstallationworks.md)
* [Under The Hood](underthehood.md)
* [No Ports Docs](README.md)

## SSH No Ports

* [Overview](ssh-no-ports/overview.md)
* [Installation Guide](ssh-no-ports/installation-guide.md)
* [Usage Guide](ssh-no-ports/usage-guide.md)

## Developer Notes <a href="#dev-notes" id="dev-notes"></a>

* [Under The Hood](dev-notes/underthehood.md)
4 changes: 2 additions & 2 deletions docs/underthehood.md → docs/dev-notes/underthehood.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Under The Hood

**Note**: This document describes version 4.0.0-rc.2 or greater; v4.0.0 will be released on or about Aug 20 2023.
**Note**: This document describes version 4.0.0-rc.2 or later. Prior versions used a different method of forming the connection.

## Overview

Expand Down Expand Up @@ -52,7 +52,7 @@ This high-level flow is visualized in the diagrams below.
### Overview diagram
![](.gitbook/assets/overview.png)
![](../.gitbook/assets/overview.png)
### Control plane
Expand Down
274 changes: 0 additions & 274 deletions docs/howinstallationworks.md

This file was deleted.

2 changes: 2 additions & 0 deletions docs/ssh-no-ports/installation-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Installation Guide

2 changes: 2 additions & 0 deletions docs/ssh-no-ports/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Overview

2 changes: 2 additions & 0 deletions docs/ssh-no-ports/usage-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Usage Guide

0 comments on commit 891022f

Please sign in to comment.