Skip to content

Commit f214790

Browse files
author
Jeremy
committed
docs: align documentation with OpenSIN-overview SSOT mandates (Hub & Spoke, Banned Tech, Naming)
1 parent dbfccdf commit f214790

4 files changed

Lines changed: 49 additions & 0 deletions

File tree

.vitepress/config.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,8 @@ export default defineConfig({
5252
{ text: 'Agent Basics', link: '/guide/agent-basics' },
5353
{ text: 'Team Orchestration', link: '/guide/team-orchestration' },
5454
{ text: 'A2A Protocol', link: '/guide/a2a-protocol' },
55+
{ text: 'Naming Conventions', link: '/guide/naming-conventions' },
56+
5557
{ text: 'MCP Integration', link: '/guide/mcp-integration' },
5658
],
5759
},

docs/architecture/a2a.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -175,3 +175,24 @@ gh repo create OpenSIN-AI/A2A-SIN-MyAgent \
175175
--template OpenSIN-AI/Template-A2A-SIN-Agent \
176176
--public
177177
```
178+
179+
## 🔄 The New Fleet Topology (Hub & Spoke)
180+
181+
As defined in the `OpenSIN-overview` SSOT, the OpenSIN A2A fleet uses a strict **Hub & Spoke** model to prevent N^2 communication chaos.
182+
183+
```mermaid
184+
graph TD;
185+
User[Operator / Telegram] -->|Task| TeamManager[Team-SIN-* Orchestrator];
186+
Hermes[SIN-Hermes Global Router] -->|Payload| TeamManager;
187+
188+
TeamManager -->|Consults| Lexicon[(Team Lexicon / RAG)];
189+
TeamManager -->|Delegate| Workers[A2A-SIN-* Worker Agents];
190+
Workers -->|Result| TeamManager;
191+
192+
TeamManager -->|Aggregate & Respond| Hermes;
193+
TeamManager -->|Aggregate & Respond| User;
194+
```
195+
196+
**Key Rules:**
197+
1. **Workers are Silent:** `A2A-SIN-*` worker agents NEVER communicate with workers from other teams. They only accept tasks from their designated `Team-SIN-*` manager.
198+
2. **Team Managers Orchestrate:** Only `Team-SIN-*` agents possess the `TELEGRAM_BOT_TOKEN` to communicate with humans.

docs/best-practices/security.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -198,3 +198,13 @@ Before deploying an agent to production:
198198
- [ ] Log redaction enabled for sensitive patterns
199199
- [ ] Token rotation configured for all long-lived credentials
200200
- [ ] `npm audit` passing with no critical vulnerabilities
201+
202+
## 🚫 Technology Sovereignty Mandate (Browser Automation)
203+
204+
**STRICTLY ENFORCED:**
205+
- **Playwright**, **Puppeteer**, **Selenium**, and **Camoufox** are **PERMANENTLY BANNED** across the entire OpenSIN-AI organization.
206+
- They are easily detected by Cloudflare, trigger massive bot-detection red flags, and lack true native stealth.
207+
208+
**THE OPENSIN STANDARD:**
209+
All A2A Agents MUST use the **OpenSIN-Bridge Chrome Extension** via the MCP WebSocket Server.
210+
Alternatively, if OS-level isolation is absolutely necessary, use `webauto-nodriver-mcp` (which wraps `nodriver`).

docs/guide/naming-conventions.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# 🏷️ Naming Conventions & SSOT
2+
3+
## The Ultimate SSOT
4+
Before modifying any code or reading further, you must be aware of the **[OpenSIN-overview](https://github.com/OpenSIN-AI/OpenSIN-overview)** repository. It is the Single Source of Truth for the entire organization.
5+
6+
## Strict Naming Schema
7+
To prevent architectural chaos, every repository in the OpenSIN-AI organization **MUST** follow this strict naming schema:
8+
9+
`[Type]-SIN-[Name]`
10+
11+
### Valid Types:
12+
- `Team-SIN-*` (Orchestrators, Hubs, Managers. E.g., `Team-SIN-Legal`)
13+
- `A2A-SIN-*` (Worker Agents that execute tasks. E.g., `A2A-SIN-ClaimWriter`)
14+
- `MCP-SIN-*` (Model Context Protocol Servers / Tools. E.g., `MCP-SIN-Browser`)
15+
- `CLI-SIN-*` (Command Line Interfaces / Terminals. E.g., `CLI-SIN-Code`)
16+
- `Template-SIN-*` (Blueprints for the forge scripts)

0 commit comments

Comments
 (0)