OpenSIN Code Docs Standard

The single source of truth for documentation across all OpenSIN-AI repositories.

Every agent, every developer, every team member MUST read this before touching any OpenSIN-AI repo.

Quick Start for Agents

1. Read this README
2. Read prompts/agent-onboarding.md
3. Follow the Repository Checklist
4. Use the Templates for every new repo
5. Follow the Standards for all documentation

What's Inside

Directory	Purpose
standards/	Documentation standards every repo must follow
templates/	Copy-paste templates for every file type
checklists/	Pre-flight checklists before creating/pushing repos
examples/	Real examples from best-in-class repos
prompts/	Agent prompts for onboarding and repo audits

The 5 Golden Rules

1. Every repo MUST have: README.md, LICENSE (MIT), CONTRIBUTING.md, SECURITY.md, CODE_OF_CONDUCT.md, CHANGELOG.md
2. Every agent repo MUST have: AGENTS.md with capabilities, team, protocol, status
3. Every package MUST have: package.json with @opensin/name, version, description, MIT license
4. Every code file MUST have: JSDoc/TSDoc for exported functions
5. Every PR MUST have: Conventional commit, linked issue, description

Current Documentation Score

Repo	Score	Status
OpenSIN	100/100	✅ Complete
OpenSIN-backend	90/100	🟡 Missing CHANGELOG
OpenSIN-Code	70/100	🟡 Missing LICENSE, CONTRIBUTING, SECURITY
awesome-opencode	50/100	🔴 Missing CONTRIBUTING, SECURITY, AGENTS
opencode-omoc-swarm	40/100	🔴 Missing LICENSE, CONTRIBUTING, SECURITY
opencode-biometrics-plugin	40/100	🔴 Missing LICENSE, CONTRIBUTING, SECURITY
sin-stripe	60/100	🟡 Missing LICENSE, CONTRIBUTING, SECURITY
SIN-Solver-Infrastructure	40/100	🔴 Missing LICENSE, CONTRIBUTING, SECURITY
sin-solver-control-plane	50/100	🔴 Missing CONTRIBUTING, SECURITY
OpenSIN-Ledger	40/100	🔴 Missing LICENSE, CONTRIBUTING, SECURITY

Target: 100/100 for ALL repos

License

MIT — Copyright (c) 2026 OpenSIN-AI