Skip to content

Commit c812504

Browse files
rjewett459rjewett459
authored
Ready to deploy SPID Protocol docs
1 parent 9f46c94 commit c812504

File tree

11 files changed

+125
-241
lines changed

11 files changed

+125
-241
lines changed

‎docs/intro.md‎

Lines changed: 47 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,47 @@
1-
import React from 'react';
2-
import Layout from '@theme/Layout';
3-
import styles from './index.module.css';
4-
5-
export default function Home() {
6-
return (
7-
<Layout title="SPID Protocol" description="Smart Packets. Structured Answers. Voice-Ready.">
8-
<main className="container margin-vert--lg">
9-
<div className="row">
10-
<div className="col col--8 col--offset-2">
11-
<h1>SPID Protocol</h1>
12-
<p className="hero__subtitle">Smart Packets. Structured Answers. Voice-Ready.</p>
13-
14-
<h2>What is SPID?</h2>
15-
<p>SPID is a resolution and retrieval protocol for AI agents, apps, and users...</p>
16-
17-
<h2>Why It Matters</h2>
18-
<p><code>spid://acme/widget123</code> → Instantly retrieves the structured packet</p>
19-
20-
<h2>Key Components</h2>
21-
<ul>
22-
<li><strong>Smart Packet Format</strong></li>
23-
<li><strong>SPID URIs</strong></li>
24-
<li><strong>SPID Directory</strong></li>
25-
<li><strong>PulseIDs</strong></li>
26-
</ul>
27-
28-
<h2>Get Involved</h2>
29-
<p>Email: <a href="mailto:hello@voicemate.id">hello@voicemate.id</a></p>
30-
</div>
31-
</div>
32-
</main>
33-
</Layout>
34-
);
35-
}
1+
# Welcome to the SPID Protocol Docs
2+
3+
The **Smart Packet Identifier (SPID) Protocol** is a modern resolution and retrieval system for AI-powered, intent-aware, and voice-ready communication.
4+
5+
---
6+
7+
## 🔍 What is SPID?
8+
9+
SPID defines how apps, AI assistants, and users access **Smart Packets** — structured, portable content units that include metadata, transcripts, intents, and actions.
10+
11+
It’s optimized for:
12+
- ✅ Voice-first environments
13+
- ✅ Intent-based interactions
14+
- ✅ Retrieval-based AI (not crawling)
15+
16+
Think of it like DNS + Open Graph + email — for the AI era.
17+
18+
---
19+
20+
## 🚀 Why It Matters
21+
22+
Traditional systems rely on scraping and guessing. SPID uses resolution:
23+
24+
```
25+
spid://acme/widget123
26+
```
27+
28+
Instantly resolves a structured, human-approved Smart Packet.
29+
30+
---
31+
32+
## 📦 Key Components
33+
34+
- **Smart Packet Format** — Self-contained structured answers
35+
- **SPID URIs** — Globally unique identifiers
36+
- **SPID Directory** — Central resolution + metadata lookup
37+
- **PulseIDs** — Async inboxes for agents and people
38+
39+
---
40+
41+
## 💬 Get Involved
42+
43+
Have ideas or questions?
44+
👉 [hello@voicemate.id](mailto:hello@voicemate.id)
45+
🌐 [spid.directory](https://spid.directory)
46+
47+
Let’s build the AI Web together.

‎docs/tutorial-basics/markdown-features.mdx‎

Lines changed: 0 additions & 152 deletions
This file was deleted.

‎docusaurus.config.js‎

Lines changed: 51 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ module.exports = {
1212
trailingSlash: false,
1313
onBrokenLinks: 'throw',
1414
onBrokenMarkdownLinks: 'warn',
15-
favicon: 'img/favicon.ico',
15+
favicon: 'img/spid_icon.ico',
1616

1717
presets: [
1818
[
@@ -31,44 +31,58 @@ module.exports = {
3131
],
3232

3333
themeConfig: {
34-
navbar: {
35-
title: 'SPID Protocol',
36-
logo: {
37-
alt: 'SPID Protocol Logo',
38-
src: 'img/logo.svg',
39-
},
40-
items: [
41-
{
42-
type: 'doc',
43-
docId: 'intro',
44-
position: 'left',
45-
label: 'Docs',
46-
},
47-
{
48-
href: 'https://github.com/SPID-Protocol-project/spidprotocol-docs',
49-
label: 'GitHub',
50-
position: 'right',
51-
},
52-
{
53-
type: 'search',
54-
position: 'right',
34+
navbar: {
35+
title: 'SPID Protocol',
36+
logo: {
37+
alt: 'SPID Protocol Logo',
38+
src: 'img/spid_icon_dark.png',
5539
},
40+
items: [
41+
{
42+
type: 'doc',
43+
docId: 'intro',
44+
position: 'left',
45+
label: 'Docs',
46+
},
47+
{
48+
href: 'https://github.com/SPID-Protocol-project/spidprotocol-docs',
49+
label: 'GitHub',
50+
position: 'right',
51+
},
52+
{
53+
type: 'search',
54+
position: 'right',
55+
},
56+
],
57+
style: 'dark',
58+
},
59+
60+
metadata: [
61+
{ name: 'twitter:card', content: 'summary_large_image' },
62+
{ name: 'twitter:title', content: 'SPID Protocol' },
63+
{ name: 'twitter:description', content: 'Smart Packets. Structured Answers. Voice-Ready.' },
64+
{ name: 'twitter:image', content: '/img/SPID-social-card.png' },
65+
{ property: 'og:image', content: '/img/SPID-social-card.png' },
66+
{ property: 'og:title', content: 'SPID Protocol' },
67+
{ property: 'og:description', content: 'Smart Packets. Structured Answers. Voice-Ready.' },
5668
],
57-
},
58-
colorMode: {
59-
defaultMode: 'dark',
60-
disableSwitch: false,
61-
respectPrefersColorScheme: true,
62-
},
63-
prism: {
64-
theme: require('prism-react-renderer/themes/github'),
65-
darkTheme: require('prism-react-renderer/themes/dracula'),
66-
},
67-
docs: {
68-
sidebar: {
69-
hideable: true,
70-
autoCollapseCategories: true,
69+
70+
colorMode: {
71+
defaultMode: 'dark',
72+
disableSwitch: false,
73+
respectPrefersColorScheme: true,
74+
},
75+
76+
prism: {
77+
theme: lightCodeTheme,
78+
darkTheme: darkCodeTheme,
79+
},
80+
81+
docs: {
82+
sidebar: {
83+
hideable: true,
84+
autoCollapseCategories: true,
85+
},
7186
},
7287
},
73-
},
7488
};

‎src/css/custom.css‎

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,24 @@
2828
--ifm-color-primary-lightest: #4fddbf;
2929
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
3030
}
31+
/* White navbar text for dark background */
3132
.navbar {
32-
background-color: #20232a;
33-
border-bottom: 1px solid #444;
33+
background-color: #000; /* black bar */
3434
}
3535

36+
.navbar__title,
37+
.navbar__item,
38+
.navbar__link {
39+
color: #ffffff !important; /* force white */
40+
}
41+
42+
.navbar__item:hover,
43+
.navbar__link:hover {
44+
color: #dddddd !important; /* slightly lighter on hover */
45+
}
46+
47+
48+
3649
.hero__title, h1, h2, h3 {
3750
font-weight: 600;
3851
}

‎src/pages/index.js‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,12 @@ export default function Home() {
66
return (
77
<Layout title="SPID Protocol" description="Smart Packets. Structured Answers. Voice-Ready.">
88
<header className={styles.hero}>
9-
<div className={styles.container}>
10-
<h1 className={styles.title}>SPID Protocol</h1>
11-
<p className={styles.tagline}>Smart Packets. Structured Answers. Voice-Ready.</p>
12-
</div>
13-
</header>
9+
<div className={styles.container}>
10+
<h1 className={styles.title}>SPID Protocol</h1>
11+
<p className={styles.tagline}>Smart Packets. Structured Answers. Voice-Ready.</p>
12+
</div>
13+
</header>
14+
1415
<main className={styles.main}>
1516
<section className={styles.section}>
1617
<h2>What is SPID?</h2>

0 commit comments

Comments
 (0)