Skip to content

Commit d720e30

Browse files
authored
Add files via upload
1 parent a1f2370 commit d720e30

File tree

5 files changed

+95
-1
lines changed

5 files changed

+95
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1-
# spidprotocol-docs
1+
# SPID Protocol Docs
2+
3+
Generated Docusaurus site for the SPID Protocol.

docusaurus.config.js

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
module.exports = {
2+
title: 'SPID Protocol',
3+
tagline: 'Smart Packets. Structured Answers. Voice-Ready.',
4+
url: 'https://yourusername.github.io',
5+
baseUrl: '/spidprotocol-docs/',
6+
onBrokenLinks: 'throw',
7+
onBrokenMarkdownLinks: 'warn',
8+
favicon: 'img/favicon.ico',
9+
organizationName: 'yourusername', // GitHub org/user
10+
projectName: 'spidprotocol-docs', // Repo name
11+
presets: [
12+
[
13+
'classic',
14+
({
15+
docs: {
16+
sidebarPath: require.resolve('./sidebars.js'),
17+
},
18+
theme: {
19+
customCss: require.resolve('./src/css/custom.css'),
20+
},
21+
}),
22+
],
23+
],
24+
};

intro.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
title: SPID Protocol SDK
3+
---
4+
5+
# SPID Protocol SDK
6+
7+
The **SPID Protocol SDK** enables you to publish and retrieve Smart Packets — structured, voice-ready, AI-retrievable answers — using a lightweight, open standard designed for the AI Web.
8+
9+
SPID is the routing layer that powers identity, intent, and resolution for asynchronous, AI-powered communication.
10+
11+
## Core Concepts
12+
13+
- **Smart Packets**: Structured voice messages with transcript, intent, metadata, and CTAs
14+
- **SPIDs**: Globally unique identifiers that resolve to Smart Packets
15+
- **PulseIDs**: Async voice inboxes for people, businesses, or agents
16+
- **Intents**: Describe the purpose and auto-generate actions
17+
18+
## Why Use the SPID Protocol SDK
19+
20+
### Principles
21+
22+
- **Structure over sprawl** — clean formatting & metadata
23+
- **Human-first** — built for voice, identity, and permission
24+
25+
### Key Features
26+
27+
- **Smart Packet Format**
28+
- **SPID Resolution**
29+
- **Intent-to-CTA Mapping**
30+
- **PulseID Routing**
31+
- **Open Schema / No Lock-in**
32+
33+
## Hello World Packet
34+
35+
```json
36+
{
37+
"spid": "spid://demo.voicemate.id/welcome",
38+
"packet": {
39+
"title": "Welcome to VoiceMate!",
40+
"voice_url": "https://cdn.voicemate.id/audio/welcome.mp3",
41+
"transcript": "Hey there, welcome to your new voice inbox.",
42+
"intent": "onboard_user",
43+
"ctas": [
44+
{ "label": "Learn More", "type": "link", "url": "https://voicemate.id/how-it-works" },
45+
{ "label": "Get Your PulseID", "type": "link", "url": "https://voicemate.id/signup" }
46+
]
47+
}
48+
}
49+
```

package.json

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"name": "spidprotocol-docs",
3+
"version": "0.0.1",
4+
"private": true,
5+
"scripts": {
6+
"start": "docusaurus start",
7+
"build": "docusaurus build",
8+
"deploy": "docusaurus deploy"
9+
},
10+
"dependencies": {
11+
"@docusaurus/core": "^3.0.1",
12+
"@docusaurus/preset-classic": "^3.0.1",
13+
"react": "^18.2.0",
14+
"react-dom": "^18.2.0"
15+
}
16+
}

sidebars.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
3+
};

0 commit comments

Comments
 (0)