README.md

OpenSIN Documentation

Quick Start · At a glance · Documentation map · Surface registry · Architecture · AI discoverability · Contributing · License

Canonical docs, governance, and surface registry for the OpenSIN-AI ecosystem.

Built for humans and agents: one source for verified public surfaces, gated experiences, and internal references.

Important

This repository documents evidence-based surfaces. If a host or route is not explicitly verified, treat it as internal or unverified until the registry says otherwise.

What this repo is

OpenSIN Documentation powers docs.opensin.ai and keeps the ecosystem canonical, searchable, and AI-discoverable. It is the place for guides, architecture notes, API references, governance docs, and live surface status.

(back to top)

Quick Start

git clone https://github.com/OpenSIN-AI/OpenSIN-documentation.git
cd OpenSIN-documentation
bun install
bun run docs:dev

Build check

node node_modules/vitepress/bin/vitepress.js build docs

(back to top)

At a glance

Item	Value
Repo type	Documentation site / knowledge base
Stack	VitePress + Bun
Deployment	Cloudflare Pages
Canonical site	https://docs.opensin.ai
AI discovery	llms.txt, llms-full.txt, public mirrors
Registry	Domain Registry

(back to top)

Documentation map

Area	Purpose	Entry point
Guide	Onboarding, installation, and day-one usage	docs/guide/getting-started.md
Architecture	System design, control planes, and trust boundaries	docs/architecture/overview.md
API	Endpoint references and protocol notes	docs/api/overview.md
Governance	Rules, registry, and handoff playbooks	docs/governance/overview.md
Best Practices	Security, performance, SEO, and reliability patterns	docs/best-practices/index.md
Tutorials	Step-by-step workflows for contributors	docs/tutorials/first-agent.md
Examples	Copy-pasteable implementation examples	docs/examples/hello-world.md
Bridges	Web, desktop, and channel integrations	docs/bridges/index.md

(back to top)

Surface registry

Surface	Status	Notes
opensin.ai	Public	Main marketing surface
my.opensin.ai	Public	Marketplace / subscription surface
blog.opensin.ai	Public	Blog and updates
docs.opensin.ai	Public	This documentation site
chat.opensin.ai	Gated	Login required; do not treat as open public
api.opensin.ai	Internal / unverified	Not publicly reachable in current checks
opensin.ai/agents	Internal / unverified	404 in public checks

See the full evidence ledger in docs/governance/domain-registry.md.

(back to top)

Architecture

flowchart TB
  Contributors["Contributors & agents"] --> Sources["README.md • docs/ • public/"]
  Sources --> Build["VitePress build"]
  Build --> Site["docs.opensin.ai"]
  Sources --> LLMS["llms.txt • llms-full.txt"]
  Site --> Registry["Domain registry"]

Loading

The repo is intentionally split between human-readable docs and machine-readable discovery files so both people and agents can navigate it quickly.

(back to top)

AI discoverability

• Root files: llms.txt and llms-full.txt
• Site mirrors: public/llms.txt and public/llms-full.txt
• Metadata: VitePress head tags and social preview assets
• Rule: update discovery files whenever the docs map or surface registry changes

(back to top)

Contributing

• Read CONTRIBUTING.md, SUPPORT.md, and CODE_OF_CONDUCT.md before opening a PR.
• Keep claims evidence-based and scoped to documentation canon.
• Update the registry first when a surface status changes.
• Validate with node node_modules/vitepress/bin/vitepress.js build docs before handing off.

(back to top)

Security

• Read SECURITY.md for the reporting path.
• Never commit secrets, tokens, or private screenshots that expose credentials.
• If a route or host is sensitive, classify it as gated or internal instead of advertising it publicly.

(back to top)

License

Distributed under the MIT License.

(back to top)

---

_{Public surfaces: opensin.ai · my.opensin.ai · blog.opensin.ai · docs.opensin.ai
Gated: chat.opensin.ai
Surface registry keeps the public/internal boundary honest.}