docs: 📝 Add docs about federation

This commit is contained in:
Jesse Wierzbinski 2024-07-27 15:37:58 +02:00
parent 0856fd4fd9
commit d1fd5c585c
No known key found for this signature in database
14 changed files with 189 additions and 40 deletions

18
app/federation/page.mdx Normal file
View file

@ -0,0 +1,18 @@
import { Guides, Guide } from '@/components/Guides';
export const metadata = {
title: 'Federation',
description:
'Description of federation behavior in Lysand.',
}
# Federation
Being a federation protocol, Lysand defines a set of rules for exchanging data between instances. This document outlines the behavior of instances in a Lysand federated network. {{ className: 'lead' }}
Federation is built on the [HyperText Transfer Protocol (HTTP)](https://tools.ietf.org/html/rfc7230) and the [JavaScript Object Notation (JSON)](https://tools.ietf.org/html/rfc7159) data format. Instances communicate with each other by sending and receiving JSON payloads over HTTP.
<Guides>
<Guide name="HTTP Guidelines" href="/federation/http" description="Guidelines for HTTP communication in Lysand." />
<Guide name="Validation" href="/federation/validation" description="Validation rules for Lysand implementations." />
</Guides>