Skip to content

Commit 4bb708f

Browse files
author
OpenSIN-AI
committed
feat: add Global Brain & Neural-Bus documentation
- Create docs/architecture/global-brain-neural-bus.md with complete documentation - Add Global Brain & Neural-Bus to VitePress sidebar config - Add .pcpm knowledge base - Update docs/index.md with ecosystem links
1 parent ffeea56 commit 4bb708f

7 files changed

Lines changed: 307 additions & 76 deletions

File tree

‎.pcpm/active-context.json‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"projectId": "OpenSIN-documentation",
3+
"goalId": "official-docs-vitepress",
4+
"goalDescription": "Official VitePress documentation for OpenSIN-AI at docs.opensin.ai",
5+
"plan": "v2 — 3/3 steps completed",
6+
"knowledge": {
7+
"rules": ["Images MUST be opened in macOS Preview.app (PRIORITY -4.5)", "Auto-sync after every chat turn (PRIORITY -4.0)"],
8+
"facts": ["OpenSIN-documentation uses VitePress for docs.opensin.ai"],
9+
"solutions": ["Created docs/architecture/global-brain-neural-bus.md", "Updated VitePress sidebar with Global Brain entry"],
10+
"forbidden": ["Broken links in documentation", "Outdated architecture descriptions"]
11+
}
12+
}

‎.pcpm/knowledge-summary.json‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"global": {
3+
"rules": [
4+
{"id": "rule-preview-mandatory", "text": "Images MUST be opened in macOS Preview.app — never tell users to check /tmp", "priority": -4.5},
5+
{"id": "rule-sin-brain-auto-sync", "text": "Auto-sync after every chat turn via sync-chat-turn hook", "priority": -4.0}
6+
]
7+
},
8+
"project": {
9+
"facts": [
10+
{"id": "fact-docs-vitepress", "text": "OpenSIN-documentation uses VitePress for docs.opensin.ai", "discoveredAt": "2026-04-13"}
11+
],
12+
"solutions": [
13+
{"id": "sol-global-brain-doc", "text": "Created docs/architecture/global-brain-neural-bus.md with complete Global Brain + Neural-Bus documentation", "createdAt": "2026-04-13"},
14+
{"id": "sol-vitepress-config-update", "text": "Added Global Brain & Neural-Bus to VitePress sidebar config", "createdAt": "2026-04-13"}
15+
]
16+
}
17+
}

‎.pcpm/plan/latest.json‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"planId": "opensin-documentation-v2",
3+
"projectId": "OpenSIN-documentation",
4+
"goalId": "official-docs-vitepress",
5+
"goalDescription": "Official VitePress documentation for OpenSIN-AI at docs.opensin.ai",
6+
"version": 2,
7+
"createdAt": "2026-04-13T17:00:00Z",
8+
"steps": [
9+
{"id": "step-1", "title": "Create Global Brain & Neural-Bus architecture doc", "status": "completed"},
10+
{"id": "step-2", "title": "Update VitePress sidebar config", "status": "completed"},
11+
{"id": "step-3", "title": "Update docs/index.md with ecosystem links", "status": "completed"}
12+
]
13+
}

‎.pcpm/rules.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Project Rules
2+
3+
## Global Rules (synced from AGENTS.md)
4+
- [2026-04-13T14:00:00Z] Images MUST be opened in macOS Preview.app — never tell users to check /tmp (priority: -4.5)
5+
- [2026-04-13T14:00:00Z] Auto-sync after every chat turn via sync-chat-turn hook (priority: -4.0)
6+
7+
## Project-Specific Rules
8+
- All architecture docs must include code examples and diagrams
9+
- New features must have corresponding documentation pages
10+
- VitePress config.js must be updated when adding new pages

‎.vitepress/config.js‎

Lines changed: 68 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -3,133 +3,137 @@ import { defineConfig } from 'vitepress';
33
export default defineConfig({
44
title: 'OpenSIN Documentation',
55
description: 'OpenSIN-AI — Autonomous AI Agent Ecosystem',
6+
srcDir: 'docs',
67
ignoreDeadLinks: true,
78
themeConfig: {
89
nav: [
9-
{ text: 'Guide', link: '/docs/guide/getting-started' },
10-
{ text: 'API', link: '/docs/api/' },
11-
{ text: 'Plugins', link: '/docs/plugins/registry' },
12-
{ text: 'Fleet', link: '/docs/fleet/overview' },
13-
{ text: 'Tutorials', link: '/docs/tutorials/first-agent' },
10+
{ text: 'Guide', link: '/guide/getting-started' },
11+
{ text: 'API', link: '/api/' },
12+
{ text: 'Architecture', link: '/architecture/overview' },
13+
{ text: 'SDK', link: '/sdk/overview' },
14+
{ text: 'Plugins', link: '/plugins/registry' },
15+
{ text: 'Tutorials', link: '/tutorials/first-agent' },
16+
{ text: 'Examples', link: '/examples/hello-world' },
1417
],
1518
sidebar: [
1619
{
1720
text: 'Guide',
1821
items: [
19-
{ text: 'Getting Started', link: '/docs/guide/getting-started' },
20-
{ text: 'Installation', link: '/docs/guide/installation' },
21-
{ text: 'Quick Start', link: '/docs/guide/quick-start' },
22-
{ text: 'Agent Basics', link: '/docs/guide/agent-basics' },
23-
{ text: 'MCP Integration', link: '/docs/guide/mcp-integration' },
24-
{ text: 'A2A Protocol', link: '/docs/guide/a2a-protocol' },
25-
{ text: 'Plugin System', link: '/docs/guide/plugin-system' },
26-
{ text: 'Team Orchestration', link: '/docs/guide/team-orchestration' },
27-
{ text: 'Deployment', link: '/docs/guide/deployment' },
28-
{ text: 'Monitoring', link: '/docs/guide/monitoring' },
29-
{ text: 'Scaling', link: '/docs/guide/scaling' },
30-
{ text: 'Troubleshooting', link: '/docs/guide/troubleshooting' },
31-
{ text: 'Changelog', link: '/docs/guide/changelog' },
32-
{ text: 'OpenSIN Code', link: '/docs/guide/opensin-code' },
33-
{ text: 'OpenSIN-AI CLI (Rust)', link: '/docs/guide/opensin-ai-cli' },
34-
{ text: 'OpenSIN-AI Code (Python)', link: '/docs/guide/opensin-ai-code' },
35-
{ text: 'Rust Engine', link: '/docs/guide/opensin-code-rust-engine' },
36-
{ text: 'OpenSIN-AI Platform', link: '/docs/guide/opensin-ai-platform' },
37-
{ text: 'Agent Features vs Competitors', link: '/docs/guide/opensin-ai-agent-features' },
22+
{ text: 'Getting Started', link: '/guide/getting-started' },
23+
{ text: 'Installation', link: '/guide/installation' },
24+
{ text: 'Quick Start', link: '/guide/quick-start' },
25+
{ text: 'Agent Basics', link: '/guide/agent-basics' },
26+
{ text: 'MCP Integration', link: '/guide/mcp-integration' },
27+
{ text: 'A2A Protocol', link: '/guide/a2a-protocol' },
28+
{ text: 'Plugin System', link: '/guide/plugin-system' },
29+
{ text: 'Team Orchestration', link: '/guide/team-orchestration' },
30+
{ text: 'Deployment', link: '/guide/deployment' },
31+
{ text: 'Monitoring', link: '/guide/monitoring' },
32+
{ text: 'Scaling', link: '/guide/scaling' },
33+
{ text: 'Troubleshooting', link: '/guide/troubleshooting' },
34+
{ text: 'Changelog', link: '/guide/changelog' },
35+
{ text: 'OpenSIN Code', link: '/guide/opensin-code' },
36+
{ text: 'OpenSIN-AI CLI (Rust)', link: '/guide/opensin-ai-cli' },
37+
{ text: 'OpenSIN-AI Code (Python)', link: '/guide/opensin-ai-code' },
38+
{ text: 'Rust Engine', link: '/guide/opensin-code-rust-engine' },
39+
{ text: 'OpenSIN-AI Platform', link: '/guide/opensin-ai-platform' },
40+
{ text: 'Agent Features vs Competitors', link: '/guide/opensin-ai-agent-features' },
3841
],
3942
},
4043
{
4144
text: 'API',
4245
items: [
43-
{ text: 'Overview', link: '/docs/api/overview' },
44-
{ text: 'Agent API', link: '/docs/api/agent' },
45-
{ text: 'A2A API', link: '/docs/api/a2a' },
46-
{ text: 'Team API', link: '/docs/api/team' },
46+
{ text: 'Overview', link: '/api/overview' },
47+
{ text: 'Agent API', link: '/api/agent' },
48+
{ text: 'A2A API', link: '/api/a2a' },
49+
{ text: 'Team API', link: '/api/team' },
4750
],
4851
},
4952
{
5053
text: 'Architecture',
5154
items: [
52-
{ text: 'Overview', link: '/docs/architecture/overview' },
53-
{ text: 'Core', link: '/docs/architecture/core' },
54-
{ text: 'A2A', link: '/docs/architecture/a2a' },
55-
{ text: 'Security', link: '/docs/architecture/security' },
55+
{ text: 'Overview', link: '/architecture/overview' },
56+
{ text: 'Core', link: '/architecture/core' },
57+
{ text: 'A2A', link: '/architecture/a2a' },
58+
{ text: 'Security', link: '/architecture/security' },
59+
{ text: 'Global Brain & Neural-Bus', link: '/architecture/global-brain-neural-bus' },
5660
],
5761
},
5862
{
5963
text: 'Plugins',
6064
items: [
61-
{ text: 'Registry', link: '/docs/plugins/registry' },
62-
{ text: 'Context Pruning', link: '/docs/plugins/context-pruning' },
63-
{ text: 'Envsitter', link: '/docs/plugins/envsitter' },
64-
{ text: 'Handoff', link: '/docs/plugins/handoff' },
65-
{ text: 'Safety Net', link: '/docs/plugins/safety-net' },
66-
{ text: 'Context Analysis', link: '/docs/plugins/context-analysis' },
67-
{ text: 'Agent Memory', link: '/docs/plugins/agent-memory' },
65+
{ text: 'Registry', link: '/plugins/registry' },
66+
{ text: 'Context Pruning', link: '/plugins/context-pruning' },
67+
{ text: 'Envsitter', link: '/plugins/envsitter' },
68+
{ text: 'Handoff', link: '/plugins/handoff' },
69+
{ text: 'Safety Net', link: '/plugins/safety-net' },
70+
{ text: 'Context Analysis', link: '/plugins/context-analysis' },
71+
{ text: 'Agent Memory', link: '/plugins/agent-memory' },
6872
],
6973
},
7074
{
7175
text: 'SDK',
7276
items: [
73-
{ text: 'Overview', link: '/docs/sdk/overview' },
74-
{ text: 'Agent Loop', link: '/docs/sdk/agent-loop' },
75-
{ text: 'Context Management', link: '/docs/sdk/context-management' },
76-
{ text: 'Hooks', link: '/docs/sdk/hooks' },
77-
{ text: 'Memory', link: '/docs/sdk/memory' },
78-
{ text: 'Model Routing', link: '/docs/sdk/model-routing' },
79-
{ text: 'Parallel Execution', link: '/docs/sdk/parallel-execution' },
80-
{ text: 'Safety', link: '/docs/sdk/safety' },
77+
{ text: 'Overview', link: '/sdk/overview' },
78+
{ text: 'Agent Loop', link: '/sdk/agent-loop' },
79+
{ text: 'Context Management', link: '/sdk/context-management' },
80+
{ text: 'Hooks', link: '/sdk/hooks' },
81+
{ text: 'Memory', link: '/sdk/memory' },
82+
{ text: 'Model Routing', link: '/sdk/model-routing' },
83+
{ text: 'Parallel Execution', link: '/sdk/parallel-execution' },
84+
{ text: 'Safety', link: '/sdk/safety' },
8185
],
8286
},
8387
{
8488
text: 'Fleet',
8589
items: [
86-
{ text: 'Overview', link: '/docs/fleet/overview' },
90+
{ text: 'Overview', link: '/fleet/overview' },
8791
],
8892
},
8993
{
9094
text: 'Governance',
9195
items: [
92-
{ text: 'Overview', link: '/docs/governance/overview' },
93-
{ text: 'Zeus', link: '/docs/governance/zeus' },
94-
{ text: 'Hermes', link: '/docs/governance/hermes' },
96+
{ text: 'Overview', link: '/governance/overview' },
97+
{ text: 'Zeus', link: '/governance/zeus' },
98+
{ text: 'Hermes', link: '/governance/hermes' },
9599
],
96100
},
97101
{
98102
text: 'Migrations',
99103
items: [
100-
{ text: 'Overview', link: '/docs/migrations/overview' },
104+
{ text: 'Overview', link: '/migrations/overview' },
101105
],
102106
},
103107
{
104108
text: 'Tutorials',
105109
items: [
106-
{ text: 'First Agent', link: '/docs/tutorials/first-agent' },
107-
{ text: 'Plugin Development', link: '/docs/tutorials/plugin-development' },
108-
{ text: 'A2A Communication', link: '/docs/tutorials/a2a-communication' },
110+
{ text: 'First Agent', link: '/tutorials/first-agent' },
111+
{ text: 'Plugin Development', link: '/tutorials/plugin-development' },
112+
{ text: 'A2A Communication', link: '/tutorials/a2a-communication' },
109113
],
110114
},
111115
{
112116
text: 'Examples',
113117
items: [
114-
{ text: 'Hello World', link: '/docs/examples/hello-world' },
115-
{ text: 'Multi-Agent', link: '/docs/examples/multi-agent' },
116-
{ text: 'Telegram Bot', link: '/docs/examples/telegram-bot' },
117-
{ text: 'Dual Auth Rotators', link: '/docs/examples/dual-auth-rotators' },
118+
{ text: 'Hello World', link: '/examples/hello-world' },
119+
{ text: 'Multi-Agent', link: '/examples/multi-agent' },
120+
{ text: 'Telegram Bot', link: '/examples/telegram-bot' },
121+
{ text: 'Dual Auth Rotators', link: '/examples/dual-auth-rotators' },
118122
],
119123
},
120124
{
121125
text: 'Best Practices',
122126
items: [
123-
{ text: 'Agent Design', link: '/docs/best-practices/agent-design' },
124-
{ text: 'Performance', link: '/docs/best-practices/performance' },
125-
{ text: 'Security', link: '/docs/best-practices/security' },
127+
{ text: 'Agent Design', link: '/best-practices/agent-design' },
128+
{ text: 'Performance', link: '/best-practices/performance' },
129+
{ text: 'Security', link: '/best-practices/security' },
126130
],
127131
},
128132
{
129133
text: 'Bridges',
130134
items: [
131-
{ text: 'Chrome Extension', link: '/docs/bridges/chrome-extension' },
132-
{ text: 'OpenSIN Bridge', link: '/docs/bridges/opensin-bridge-overview' },
135+
{ text: 'Chrome Extension', link: '/bridges/chrome-extension' },
136+
{ text: 'OpenSIN Bridge', link: '/bridges/opensin-bridge-overview' },
133137
],
134138
},
135139
],

0 commit comments

Comments
 (0)