diff --git a/app/favicon.ico b/app/favicon.ico deleted file mode 100644 index 2deafb7..0000000 Binary files a/app/favicon.ico and /dev/null differ diff --git a/app/quickstart/page.mdx b/app/introduction/page.mdx similarity index 100% rename from app/quickstart/page.mdx rename to app/introduction/page.mdx diff --git a/app/layout.tsx b/app/layout.tsx index e4e00db..e156118 100644 --- a/app/layout.tsx +++ b/app/layout.tsx @@ -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 ( + + +
diff --git a/app/page.mdx b/app/page.mdx index d3999f7..b83d3f5 100644 --- a/app/page.mdx +++ b/app/page.mdx @@ -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' }, ] -# 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' }}
-## 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' }} + +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). + -
- -
+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**. diff --git a/components/Logo.tsx b/components/Logo.tsx index a3ee6df..ce2e6d0 100644 --- a/components/Logo.tsx +++ b/components/Logo.tsx @@ -1,16 +1,20 @@ +import logo from "@/images/branding/logo.webp"; +import clsx from "clsx"; import type { ComponentPropsWithoutRef } from "react"; -export function Logo(props: ComponentPropsWithoutRef<"svg">) { +export function Logo(props: ComponentPropsWithoutRef<"div">) { return ( - +
+ Logo + + Lysand Protocol + +
); } diff --git a/components/Navigation.tsx b/components/Navigation.tsx index 10e5bc2..6faab10 100644 --- a/components/Navigation.tsx +++ b/components/Navigation.tsx @@ -170,7 +170,7 @@ function NavigationGroup({
  • {group.title} diff --git a/images/branding/logo-full.webp b/images/branding/logo-full.webp new file mode 100644 index 0000000..8c01cc4 Binary files /dev/null and b/images/branding/logo-full.webp differ diff --git a/images/branding/logo.webp b/images/branding/logo.webp new file mode 100644 index 0000000..2132bca Binary files /dev/null and b/images/branding/logo.webp differ diff --git a/public/favicon.png b/public/favicon.png new file mode 100644 index 0000000..5bfb829 Binary files /dev/null and b/public/favicon.png differ