|
1 | | -# Website |
| 1 | +# SPID Protocol Documentation |
2 | 2 |
|
3 | | -This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. |
| 3 | +<img src="https://raw.githubusercontent.com/SPID-Protocol-project/spidprotocol-docs/main/static/img/spid_icon_dark.png" alt="SPID Protocol Logo" width="180" /> |
4 | 4 |
|
5 | | -### Installation |
| 5 | +**The Smart Packet Identity Layer (SPID)** is an open protocol that powers AI-native, voice-ready communication through structured metadata and universal identifiers. This repository contains the official documentation for SPID and its core components. |
6 | 6 |
|
7 | | -``` |
8 | | -$ yarn |
9 | | -``` |
| 7 | +--- |
10 | 8 |
|
11 | | -### Local Development |
| 9 | +## 🚀 What is the SPID Protocol? |
12 | 10 |
|
13 | | -``` |
14 | | -$ yarn start |
15 | | -``` |
| 11 | +The SPID Protocol defines a new standard for async, AI-mediated communication using **Smart Packets** — rich, structured messages containing: |
16 | 12 |
|
17 | | -This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. |
| 13 | +- A short voice message |
| 14 | +- A full transcript |
| 15 | +- Inferred user intent |
| 16 | +- Actionable CTA buttons |
| 17 | +- Verified identity and metadata |
18 | 18 |
|
19 | | -### Build |
| 19 | +SPID is the identity and resolution layer that links each packet to its origin, purpose, and destination. Think of it as **DNS + Schema.org + Email headers for the AI web** — enabling machines to route, respond, and retrieve context-aware messages without noise or ambiguity. |
20 | 20 |
|
21 | | -``` |
22 | | -$ yarn build |
23 | | -``` |
| 21 | +--- |
24 | 22 |
|
25 | | -This command generates static content into the `build` directory and can be served using any static contents hosting service. |
| 23 | +## 🧠 Why It Matters |
26 | 24 |
|
27 | | -### Deployment |
| 25 | +Traditional communication (email, calls, SMS) is outdated for an AI-driven world. Smart Packets and SPID enable: |
28 | 26 |
|
29 | | -Using SSH: |
| 27 | +- ✅ **Voice-first communication** that’s human-friendly and AI-optimized |
| 28 | +- 🧩 **Structured data** that powers LLM routing and reasoning |
| 29 | +- 🕸️ **Linkable metadata** for seamless discovery and retrieval |
| 30 | +- 🔐 **Verified identity and intent**, protecting against spam and impersonation |
| 31 | +- 📦 **Portable messages**, ready to be shared, archived, or embedded anywhere |
30 | 32 |
|
31 | | -``` |
32 | | -$ USE_SSH=true yarn deploy |
33 | | -``` |
| 33 | +--- |
34 | 34 |
|
35 | | -Not using SSH: |
| 35 | +## 📚 Documentation Contents |
36 | 36 |
|
37 | | -``` |
38 | | -$ GIT_USER=<Your GitHub username> yarn deploy |
39 | | -``` |
| 37 | +This repository is built with [Docusaurus](https://docusaurus.io) and contains: |
40 | 38 |
|
41 | | -If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. |
| 39 | +- `docs/` — Core specs, guides, and implementation details |
| 40 | +- `static/` — SPID logo assets and shared resources |
| 41 | +- `docusaurus.config.js` — Site configuration and navbar settings |
| 42 | + |
| 43 | +--- |
| 44 | + |
| 45 | +## 📦 Get Started |
| 46 | + |
| 47 | +To contribute or run locally: |
| 48 | + |
| 49 | +```bash |
| 50 | +# Install dependencies |
| 51 | +npm install |
| 52 | + |
| 53 | +# Start local dev server |
| 54 | +npm run start |
0 commit comments