Skip to content

README.md

Latest commit

 

History

History
108 lines (83 loc) · 3.84 KB

README.md

File metadata and controls

108 lines (83 loc) · 3.84 KB

OpenSIN-AI Logo

OpenSIN-AI Documentation

The canonical knowledge layer for the OpenSIN-AI ecosystem — docs.opensin.ai

Deploy Status Docs Live License Bun

Quick Start · Structure · Governance · Contributing

Important

This repository is the Single Source of Truth (SSOT) for all OpenSIN-AI documentation, API references, and architecture blueprints. It is managed by the OpenSIN-AI Governance Board.

The visual design language shown on docs.opensin.ai is now the canonical OpenSIN web design baseline for all other surfaces. Keep developers.opensin.ai and member.opensin.ai aligned to this look, but preserve their separate runtimes and repos.

🚀 Quick Start

This project uses VitePress and Bun.

# Install dependencies (BUN ONLY)
bun install

# Run development server
bun run dev

# Build for production
bun ./scripts/build-docs.mjs

Note

Keep companion repos and local worktrees outside this repository root. Use sibling directories such as ~/dev/<repo> so OpenSIN-documentation/ stays clean during sync, checkout, and review.

📂 Structure

OpenSIN-documentation/
├── docs/               # Documentation Content (VitePress)
│   ├── guide/          # Getting Started & User Guides
│   ├── api/            # API Reference
│   ├── architecture/   # Deep Dive into the Engine
│   ├── fleet/          # A2A Agent Fleet Registry
│   └── governance/     # Protocols, Rules & Ethics
├── scripts/            # Build & Maintenance tools
├── package.json        # Project metadata
└── AGENTS.md           # Mandatory Agent directives

⚖️ Governance

All documentation follows the OpenSIN 2026 Standards:

  • A2A-First: Every agent interaction is documented via the A2A protocol.
  • Global Brain: Syncs with https://github.com/Delqhi/global-brain.
  • Surface Plan: Aligned with OpenSIN-Web-Surface-Plan.

🤝 Contributing

We welcome contributions! Please see CONTRIBUTING.md for details.

  1. Fork the repo.
  2. Create a feature branch.
  3. Commit changes (Agent-led commits preferred).
  4. Open a Pull Request.

Powered by OpenSIN-AI

Developed by the OpenSIN-AI Ecosystem — Enterprise AI Agents working autonomously.
🌐 opensin.ai · 💬 Agents · 🚀 Dashboard

(back to top)