Skip to content

Commit 0874fff

Browse files
authored
Update homepage content
1 parent a4fa077 commit 0874fff

File tree

8 files changed

+141
-105
lines changed

8 files changed

+141
-105
lines changed

docs/intro.md

Lines changed: 4 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -2,46 +2,9 @@
22
sidebar_position: 1
33
---
44

5-
# Tutorial Intro
5+
# Welcome to SPID Protocol
66

7-
Let's discover **Docusaurus in less than 5 minutes**.
7+
This is your SPID Protocol documentation.
8+
Feel free to update this page or add more!
89

9-
## Getting Started
10-
11-
Get started by **creating a new site**.
12-
13-
Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**.
14-
15-
### What you'll need
16-
17-
- [Node.js](https://nodejs.org/en/download/) version 18.0 or above:
18-
- When installing Node.js, you are recommended to check all checkboxes related to dependencies.
19-
20-
## Generate a new site
21-
22-
Generate a new Docusaurus site using the **classic template**.
23-
24-
The classic template will automatically be added to your project after you run the command:
25-
26-
```bash
27-
npm init docusaurus@latest my-website classic
28-
```
29-
30-
You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.
31-
32-
The command also installs all necessary dependencies you need to run Docusaurus.
33-
34-
## Start your site
35-
36-
Run the development server:
37-
38-
```bash
39-
cd my-website
40-
npm run start
41-
```
42-
43-
The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there.
44-
45-
The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.
46-
47-
Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes.
10+
Learn more: [https://spidprotocol.org](https://spidprotocol.org)

docusaurus.config.js

Lines changed: 39 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,25 @@
1-
// docusaurus.config.js
1+
const lightCodeTheme = require('prism-react-renderer/themes/github');
2+
const darkCodeTheme = require('prism-react-renderer/themes/dracula');
3+
24
module.exports = {
35
title: 'SPID Protocol',
46
tagline: 'Smart Packets. Structured Answers. Voice-Ready.',
5-
url: 'https://SPID-Protocol-project.github.io', // GitHub org/user URL
6-
baseUrl: '/spidprotocol-docs/', // GitHub repo name with slashes
7+
url: 'https://SPID-Protocol-project.github.io',
8+
baseUrl: '/spidprotocol-docs/',
79
organizationName: 'SPID-Protocol-project',
810
projectName: 'spidprotocol-docs',
911
deploymentBranch: 'gh-pages',
1012
trailingSlash: false,
1113
onBrokenLinks: 'throw',
1214
onBrokenMarkdownLinks: 'warn',
1315
favicon: 'img/favicon.ico',
16+
1417
presets: [
1518
[
1619
'classic',
1720
{
1821
docs: {
19-
routeBasePath: '/',
22+
routeBasePath: '/docs',
2023
sidebarPath: require.resolve('./sidebars.js'),
2124
},
2225
blog: false,
@@ -26,4 +29,36 @@ module.exports = {
2629
},
2730
],
2831
],
32+
33+
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',
55+
},
56+
],
57+
style: 'dark',
58+
},
59+
prism: {
60+
theme: lightCodeTheme,
61+
darkTheme: darkCodeTheme,
62+
},
63+
},
2964
};

package-lock.json

Lines changed: 31 additions & 9 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
"@docusaurus/preset-classic": "3.7.0",
1919
"@mdx-js/react": "^3.0.0",
2020
"clsx": "^2.0.0",
21-
"prism-react-renderer": "^2.3.0",
21+
"prism-react-renderer": "^1.3.5",
2222
"react": "^19.0.0",
2323
"react-dom": "^19.0.0"
2424
},

src/pages/index.js

Lines changed: 37 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,46 @@
1-
import clsx from 'clsx';
2-
import Link from '@docusaurus/Link';
3-
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
1+
import React from 'react';
42
import Layout from '@theme/Layout';
5-
import HomepageFeatures from '@site/src/components/HomepageFeatures';
6-
7-
import Heading from '@theme/Heading';
83
import styles from './index.module.css';
94

10-
function HomepageHeader() {
11-
const {siteConfig} = useDocusaurusContext();
12-
return (
13-
<header className={clsx('hero hero--primary', styles.heroBanner)}>
14-
<div className="container">
15-
<Heading as="h1" className="hero__title">
16-
{siteConfig.title}
17-
</Heading>
18-
<p className="hero__subtitle">{siteConfig.tagline}</p>
19-
<div className={styles.buttons}>
20-
<Link
21-
className="button button--secondary button--lg"
22-
to="/docs/intro">
23-
Docusaurus Tutorial - 5min ⏱️
24-
</Link>
25-
</div>
26-
</div>
27-
</header>
28-
);
29-
}
30-
315
export default function Home() {
32-
const {siteConfig} = useDocusaurusContext();
336
return (
347
<Layout
35-
title={`Hello from ${siteConfig.title}`}
36-
description="Description will go into a meta tag in <head />">
37-
<HomepageHeader />
38-
<main>
39-
<HomepageFeatures />
8+
title="SPID Protocol"
9+
description="Smart Packets. Structured Answers. Voice-Ready.">
10+
<header className={styles.hero}>
11+
<div className={styles.container}>
12+
<h1 className={styles.title}>SPID Protocol</h1>
13+
<p className={styles.tagline}>Smart Packets. Structured Answers. Voice-Ready.</p>
14+
</div>
15+
</header>
16+
<main className={styles.main}>
17+
<section className={styles.section}>
18+
<h2>🔍 What is SPID?</h2>
19+
<p>
20+
SPID is a resolution and retrieval protocol for AI agents, apps, and users to access structured,
21+
voice-ready content units called Smart Packets — complete with transcripts, metadata, intents, and CTAs.
22+
</p>
23+
</section>
24+
<section className={styles.section}>
25+
<h2>🚀 Why It Matters</h2>
26+
<p>
27+
SPID replaces guesswork and scraping with resolution. For example:<br />
28+
<code>spid://acme/widget123</code> → instantly retrieves the structured packet.
29+
</p>
30+
</section>
31+
<section className={styles.section}>
32+
<h2>📦 Key Components</h2>
33+
<ul>
34+
<li><strong>Smart Packet Format</strong> — Self-contained, structured answers</li>
35+
<li><strong>SPID URIs</strong> — Globally unique addresses</li>
36+
<li><strong>SPID Directory</strong> — Central resolution service</li>
37+
<li><strong>PulseIDs</strong> — Async inboxes for agents and people</li>
38+
</ul>
39+
</section>
40+
<section className={styles.section}>
41+
<h2>💬 Get Involved</h2>
42+
<p>Email us at <a href="mailto:hello@voicemate.id">hello@voicemate.id</a> or visit <a href="https://spid.directory">spid.directory</a>.</p>
43+
</section>
4044
</main>
4145
</Layout>
4246
);

src/pages/index.module.css

Lines changed: 29 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,35 @@
1-
/**
2-
* CSS files with the .module.css suffix will be treated as CSS modules
3-
* and scoped locally.
4-
*/
5-
6-
.heroBanner {
7-
padding: 4rem 0;
1+
.hero {
2+
background-color: #000;
3+
color: #fff;
4+
padding: 4rem 1rem;
85
text-align: center;
9-
position: relative;
10-
overflow: hidden;
116
}
127

13-
@media screen and (max-width: 996px) {
14-
.heroBanner {
15-
padding: 2rem;
16-
}
8+
.container {
9+
max-width: 800px;
10+
margin: 0 auto;
11+
}
12+
13+
.title {
14+
font-size: 3rem;
15+
font-weight: 700;
16+
}
17+
18+
.tagline {
19+
font-size: 1.25rem;
20+
margin-top: 1rem;
21+
}
22+
23+
.main {
24+
padding: 2rem 1rem;
25+
max-width: 960px;
26+
margin: 0 auto;
27+
}
28+
29+
.section {
30+
margin-bottom: 2.5rem;
1731
}
1832

19-
.buttons {
20-
display: flex;
21-
align-items: center;
22-
justify-content: center;
33+
.section h2 {
34+
margin-bottom: 0.75rem;
2335
}

static/img/spid-logo.png

93.5 KB
Loading

static/img/spid_logo.png

1.24 MB
Loading

0 commit comments

Comments
 (0)