docs: Restructure & Improvements (#255)

Author: CodeShellDev

.github/templates/README.template.md

@@ -402,7 +402,7 @@ Has this Repo been helpful 👍️ to you? Then consider ⭐️'ing this Project
 
 ## Help
 
-**Are you having problems setting up Secured Signal API?**<br>
+**Are you having problems setting up Secured Signal API?**<br/>
 No worries check out the [discussions](https://github.com/codeshelldev/secured-signal-api/discussions) tab and ask for help.
 
 **We are all volunteers**, so please be friendly and patient.

.gitignore

@@ -27,4 +27,13 @@ yarn-error.log*
 
 # Allow .github
 !.github
-!.prettierignore
+!.prettierignore
+
+# Generated api files
+api_versioned_docs
+api_versioned_sidebars
+api/generated
+
+# NPM
+
+!.npmrc

.npmrc

@@ -0,0 +1 @@
+loglevel=silent

api/openapi-v1.5.1.yaml

@@ -0,0 +1,95 @@
+openapi: "3.0.0"
+
+info:
+  version: ""
+  description: ""
+  title: Secured Signal API
+
+paths:
+  /v1/about:
+    get:
+      description: Returns general information about the underlying API as well as about **Secured Signal API**.
+      summary: List API information
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/client.About"
+      tags:
+        - General
+
+tags:
+  - description: Some general endpoints
+    name: General
+  - description: Register and link Devices
+    name: Devices
+  - description: List registered and linked accounts
+    name: Accounts
+  - description: Create, List and Delete Signal Groups
+    name: Groups
+  - description: Send and Receive Signal Messages
+    name: Messages
+  - description: List and Delete Attachments
+    name: Attachments
+  - description: Update Profile
+    name: Profiles
+  - description: List and Trust Identities
+    name: Identities
+  - description: React to messages
+    name: Reactions
+  - description: Send receipts for messages
+    name: Receipts
+  - description: Search the Signal Service
+    name: Search
+  - description: List and Install Sticker Packs
+    name: Sticker Packs
+
+components:
+  schemas:
+    client.About:
+      type: object
+      properties:
+        build:
+          type: integer
+        mode:
+          type: string
+        version:
+          type: string
+        versions:
+          type: array
+          items:
+            type: string
+        capabilities:
+          type: object
+          additionalProperties:
+            type: array
+            items:
+              type: string
+          example:
+            /v2/send/:
+              - mentions
+              - quotes
+        secured-signal-api:
+          type: object
+          description: Information about **Secured Signal API**
+          properties:
+            version:
+              type: string
+              description: Version extracted from the image tag with semver formatting (if invalid, then `version` is empty)
+            auth_required:
+              type: boolean
+              description: Is authentication required for accessing the API?
+            capabilities:
+              type: object
+              additionalProperties:
+                type: array
+                items:
+                  type: string
+      required:
+        - build
+        - mode
+        - version
+        - versions
+        - capabilities