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

feat: ✨ Add branding, port more text from old site

Browse source
This commit is contained in:
Jesse Wierzbinski 2024-07-22 13:12:55 +02:00
parent 02695bc22c
commit 5ab772df21
No known key found for this signature in database
9 changed files with 37 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

BIN
app/favicon.ico
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 15 KiB

0
app/quickstart/page.mdx → app/introduction/page.mdx
View file

7
app/layout.tsx
View file

@ -10,8 +10,8 @@ import type { ReactNode } from "react";
export const metadata: Metadata = {
title: {
template: "%s - Protocol API Reference",
default: "Protocol API Reference",
template: "%s - Lysand API Reference",
default: "Lysand API Reference",
},
};
@ -31,6 +31,9 @@ export default async function RootLayout({
return (
<html lang="en" className="h-full" suppressHydrationWarning={true}>
<head>
<link rel="icon" href="/favicon.png" type="image/png" />
</head>
<body className="flex min-h-full bg-white antialiased dark:bg-zinc-900">
<Providers>
<div className="w-full">

28
app/page.mdx
View file

@ -3,40 +3,44 @@ import { Resources } from '@/components/Resources'
import { HeroPattern } from '@/components/HeroPattern'
export const metadata = {
title: 'API Documentation',
title: 'Lysand Documentation',
description:
'Learn everything there is to know about the Protocol API and integrate Protocol into your product.',
'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' },
]
<HeroPattern />
# API Documentation
# Lysand Federation Protocol
Use the Protocol API to access contacts, conversations, group messages, and more and seamlessly integrate your product into the workflows of dozens of devoted Protocol users. {{ className: 'lead' }}
The Lysand Protocol is designed as a communication medium for federated applications, leveraging the HTTP stack. Its simplicity ensures ease of implementation and comprehension. {{ className: 'lead' }}
<div className="not-prose mb-16 mt-6 flex gap-3">
<Button href="/quickstart" arrow="right">
<>Quickstart</>
<>Introduction</>
</Button>
<Button href="/sdks" variant="outline">
<>Explore SDKs</>
</Button>
</div>
## Getting started {{ anchor: false }}
## Vocabulary
To get started, create a new application in your [developer settings](#), then read about how to make requests for the resources you need to access using our HTTP APIs or dedicated client SDKs. When your integration is ready to go live, publish it to our [integrations directory](#) to reach the Protocol community. {{ className: 'lead' }}
<Note>
The words **MUST**, **MUST NOT**, **SHOULD**, **SHOULD NOT**, and **MAY** are used in this document as defined in [RFC 2119](https://tools.ietf.org/html/rfc2119).
</Note>
<div className="not-prose">
<Button href="/sdks" variant="text" arrow="right">
<>Get your API key</>
</Button>
</div>
The Lysand Protocol uses the following terms:
- **Entity**: A generic term for any JSON object in the protocol, such as an [Actor](./objects/actors), a [Note](./objects/notes), or a [Like](./objects/likes). Entities are uniquely identified by their `id` property.
- **Implementation**: A software application that implements the Lysand Protocol.
- **Instance**: An application deploying an **Implementation**.
- 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 />