starting docs infra

This commit is contained in:
DecDuck
2024-10-25 13:15:46 +11:00
parent 24a0d118f2
commit 7d2a1c6952
16 changed files with 1647 additions and 19 deletions

1
docs/.about.txt Normal file
View File

@ -0,0 +1 @@
These docs are automatically compiled in the Drop UI and are designed for admins and users to understand how Drop works.

3
docs/1.index.md Normal file
View File

@ -0,0 +1,3 @@
# Home
This page is intentionally left blank, as it should be replaced with a custom home page.

23
docs/about/1.API.md Normal file
View File

@ -0,0 +1,23 @@
# API
All Drop components communicate through HTTP-based APIs. However, due to the different use-cases they differ in how they are used.
## Frontend APIs
Frontend APIs run on the server, and are found under `/api/v1/`. They are used to render the web frontend, and are focused around user-based control of Drop systems.
For example, frontend APIs are responsible for uploading profile pictures, customizing your profile and adding friends.
The frontend, however, does not have access to some Drop features, namely downloading content. That feature is reserved for the client APIs, where it is actually used.
## Client APIs
Client APIs run on the server, and are found under `/api/v1/client/`. They are used by Drop clients (namely the desktop client) to manage, download and communicate with other Drop clients. They have a very specific feature set, and are limited in how they can change user profiles.
For example, client APIs have the ability to download content, setup P2P connections and report game activity. However, they do not have access to user profile management or administrator controls.
## P2P APIs
P2P APIs run on Drop clients, and are found at the root of the HTTP server. They are used by other Drop clients to download content and negotiate P2P features. They use mTLS authentication as a lightweight and efficient way to do peer to peer authentication.
For example, P2P APIs would be used to negotiate a Wireguard tunnel to do Remote LAN play.

11
docs/about/clients.md Normal file
View File

@ -0,0 +1,11 @@
# Clients
Drop clients connected to a given Drop server can access:
- Game content and files (to download)
- User data
- Game metadata and images
- Information about other clients connected to the same Drop server
**It is important that you trust the client that you grant access to your Drop account.**

5
docs/about/index.md Normal file
View File

@ -0,0 +1,5 @@
# About
This section is about what Drop does, and how it works. For users interested in the inner workings of Drop, this will go through many of the design decisions, why they were made and more!
For users that don't care how Drop works, and want help using Drop, look under other sections. This section is purely technical and theoretical.