From 6ab622d1097a945e1d69696d2381d05fe0518c4a Mon Sep 17 00:00:00 2001 From: shockrah Date: Tue, 23 Feb 2021 21:44:26 -0800 Subject: [PATCH] adding first pass of overview section --- docs/content/overview/_index.md | 5 ++++ docs/content/overview/protocol.md | 40 +++++++++++++++++++++++++++++++ 2 files changed, 45 insertions(+) create mode 100644 docs/content/overview/_index.md create mode 100644 docs/content/overview/protocol.md diff --git a/docs/content/overview/_index.md b/docs/content/overview/_index.md new file mode 100644 index 0000000..ec6bc89 --- /dev/null +++ b/docs/content/overview/_index.md @@ -0,0 +1,5 @@ +--- +title: Overview +anchor: overview +weight: 5 +--- diff --git a/docs/content/overview/protocol.md b/docs/content/overview/protocol.md new file mode 100644 index 0000000..978e41a --- /dev/null +++ b/docs/content/overview/protocol.md @@ -0,0 +1,40 @@ +--- +title: Protocol +anchor: protocol +weight: 6 +--- + +## What this section covers + +What one should expect when attempting to implement a server/client compliant +with the Freechat protocol. + +## What this section does not cover + +Details on implementation are found under: + +* [JSON API Endpoints](#endpoints) + +Details what endpoints are available to send/receive data through. + +* [Structures](#structures) + +Details what kind of data is sent back and forth between clients and servers. + +## Overview Content + +The Freechat protocol is based on HTTP and currently outlines a _json-based_ API +hereafter referred to as just, the "JSON API". +Due to the standards already in place with HTTP and JSON it is safe to assume +that this protocol be more of an outline for what HTTP endpoints to have and what kind of data is to be expected in exchanges. + +* Endpoints listed in the [JSON API Endpoints section](#endpoints). + +* Data structures are also outline under the [structures](#structures) section. + +Most servers will likely run on one of three ports, `80` for basic HTTP, `443` for secure HTTP traffic, or `4536` for most others. +If using a _special port_ then servers should expect _user applications_ to specify the port. + +For connections over SSH or other protocols it really is up to server owners to let new users know about this important detail. +SSH based servers are not discouraged, in fact they are highly _encouraged_ to exist and operate :^) +