versia-pub/docs
2
0
Fork 0
mirror of https://github.com/versia-pub/docs.git synced 2026-03-13 02:49:16 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: 📝 Finish main page, add guides

Browse source
This commit is contained in:
Jesse Wierzbinski 2024-07-22 13:26:09 +02:00
parent 5ab772df21
commit 3545bf525f
No known key found for this signature in database
3 changed files with 23 additions and 59 deletions
Download patch file Download diff file Expand all files Collapse all files

22
app/page.mdx
View file

@ -3,15 +3,14 @@ import { Resources } from '@/components/Resources'
import { HeroPattern } from '@/components/HeroPattern'
export const metadata = {
title: 'Lysand Documentation',
description:
'Introduction to the Lysand Protocol, a communication medium for federated applications, leveraging the HTTP stack.',
title: 'Lysand Documentation',
description: 'Introduction to the Lysand Protocol, a communication medium for federated applications, leveraging the HTTP stack.',
}
export const sections = [
{ title: 'Vocabulary', id: 'vocabulary' },
{ title: 'Guides', id: 'guides' },
{ title: 'Resources', id: 'resources' },
{ title: 'Vocabulary', id: 'vocabulary' },
{ title: 'Basic Concepts', id: 'basic-concepts' },
{ title: 'Resources', id: 'resources' },
]
<HeroPattern />
@ -42,6 +41,15 @@ The Lysand Protocol uses the following terms:
- Using the same nomenclature, an ActivityPub Implementation would be `Mastodon`, and an Instance would be `mastodon.social`.
- **Federation**: The process of exchanging data between two or more **Instances**.
<Guides />
## Philosophy
The Lysand Protocol is heavily inspired by the [ActivityPub](https://www.w3.org/TR/activitypub/) specification. It is designed to be simple and easy to implement, with a focus on the following concepts:
- **Simple Structures**: Entities are represented as JSON objects. No JSON-LD, no complex data structures, just plain JSON.
- **Modularity**: The protocol is divided into a **core protocol** and **extensions**. Implementations can choose to support only the core protocol or add extensions as needed.
- **Namespacing**: To avoid extension conflicts, all extensions are namespaced.
- **Signatures**: Most types of interactions **must** be signed with a private key. Unlike other protocols, signatures are **mandatory**, not optional.
- **Developer-Friendliness**: Understanding and implementing your own Lysand server should be easy. Documentation is aimed at developers first.
{/* <Guides /> */}
<Resources />