Skip to content

docs(co-docs): add docs/ structure with ARCHITECTURE / LEARNING / SAFETY / COOKBOOK / SWARM / MCP / CONTRIBUTING / CHANGELOG #1

Description

@Delqhi

Context

SIN-Code CoDocs standard mandates that every project carries a docs/ companion
folder describing the why and how of its design. The AGENTS.md captures the
non-negotiable invariants but the modular reasoning behind them lives elsewhere.

Goal

Add a complete docs/ tree following the SIN-Code CoDocs standard, mirroring
the architecture of the SIN-Code WebUI v2 docs (ARCHITECTURE / LEARNING /
SAFETY / COOKBOOK / SWARM / MCP / CONTRIBUTING / CHANGELOG).

Acceptance criteria

  • 8 docs/ markdown files added
  • README.md links the docs in a Documentation table
  • pyproject.toml [project.urls] points to OpenSIN-Code/autodev-cli
  • docs/CHANGELOG.md reflects v0.1.0 + v0.2.0 history
  • docs/MCP.md explains the new autodev-mcp bridge pattern
  • Quality gates pass: ruff ✓ pyright ✓ pytest 67/67 ✓
  • Force-pushed main @ 5a78009 after branch protection lowering

Verifikation

pip install -e ".[dev]"
ruff check .                   # 0 errors
pyright .                      # 0 errors
pytest tests/                  # 67 passed

Sister project linkage

OpenSIN-Code/SIN-Code-WebUI-v2#93 (parallel-spawn autodev-mcp alongside
sin-code) is the consumer side of this docs work.

Refs: #91 (closed via this pattern, applies to sin-websearch too)

Refs: #2

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions