Skip to content

docs: Update all README.md files across OpenSIN-Code repos to current state #39

@Delqhi

Description

@Delqhi

Description

README files across the OpenSIN-Code organization are outdated. Many show old version numbers, missing features, or incorrect installation instructions.

Scope: All 45+ OpenSIN-Code repos need README audit

Known Issues (from deep scans)

Repo Issue
SIN-Code-Bundle README may not reflect v1.2.0 features (sin code hub, sin sckg, tests)
SIN-Code-SCKG-Tool README likely shows v0.2.0, now v0.6.1 with GraphQL, dashboard, hybrid search
SIN-Code-Security-Bundle README shows 5 tools, now 8 (added SAST, Secrets, SBOM)
SIN-Code-Discover/Execute/Map/Grasp/Scout/Harvest/Orchestrate Version tags inconsistent (-codocs, -initial, -ceo-audit-v3)
SIN-Code-IBD/PoC/ADW/Oracle/EFM Show v0.1.0, minimal READMEs (3 lines)
All Python tools Missing AGENTS.md reference in README
Simone-MCP README may not reflect v0.6.0 protocol fix
SIN-Browser-Tools README may not list all 106 tools

Standard README Template (all repos should follow)

# Repo Name

One-line description.

## Status
- **Version**: vX.Y.Z (link to releases)
- **Maturity**: Production / MVP / Alpha / Spec-only
- **Language**: Go / Python / TypeScript
- **Tests**: N tests passing
- **CI**: ✅ Passing / ❌ Missing

## Installation
```bash
# Python
pip install -e .

# Go
go build -o ~/.local/bin/tool ./cmd/tool

Usage

tool --help
tool <command> [args]

MCP Integration

  • MCP Server: server.py / mcp_server.go
  • Tools: N tools exposed
  • Register: sin mcp register ...

Development

  • CoDocs: N .doc.md companions
  • AGENTS.md: ✅ Present
  • Tests: pytest tests/ / go test ./...
  • Lint: ruff check . / golangci-lint run

License

MIT


## Acceptance Criteria
- [ ] All 45+ repos have README matching template
- [ ] Version numbers match latest git tag
- [ ] Installation instructions work
- [ ] MCP integration documented
- [ ] CoDocs/AGENTS.md compliance noted
- [ ] Maturity badge shown (Production/MVP/Alpha/Spec)

## Priority
**MEDIUM** — Documentation debt; blocks onboarding and trust

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions