Skip to content

docs: HARNESS / INVARIANTS / BOUNDARIES / DEVELOPMENT / EVAL_HARNESS / SECURITY / ARCHITECTURE + README + CONTRIBUTING + CLAUDE + CHANGELOG + TASKS (#25, #26)#61

Merged
constk merged 1 commit into
developfrom
feat/25-26-docs
Apr 27, 2026
Merged

docs: HARNESS / INVARIANTS / BOUNDARIES / DEVELOPMENT / EVAL_HARNESS / SECURITY / ARCHITECTURE + README + CONTRIBUTING + CLAUDE + CHANGELOG + TASKS (#25, #26)#61
constk merged 1 commit into
developfrom
feat/25-26-docs

Conversation

@constk
Copy link
Copy Markdown
Owner

@constk constk commented Apr 27, 2026

Closes #25 + #26. Seven doc skeletons under docs/ + five top-level docs. All template-flavoured, no Teller leakage.

…URITY, ARCHITECTURE + README, CONTRIBUTING, CLAUDE.md, CHANGELOG, TASKS.md (#25, #26)

Closes #25 + #26 in one PR (the README references docs/* paths and TASKS.md
references everything else; landing them separately would mean a half-broken
docs tree in between).

docs/* (all written for the template, not Teller-flavoured):
- HARNESS.md     — umbrella table mapping every layer to its config file
                   and to the meta-gate(s) that catch drift in it.
- INVARIANTS.md  — five portable rules with numbered slots 6+ for project
                   additions.
- BOUNDARIES.md  — ASCII layer diagram + the import-linter contract spec
                   + how to add a layer cleanly.
- DEVELOPMENT.md — prereqs, first-time setup, dev stack, justfile recipes
                   table, branching diagram, commit-prefix table, CI
                   workflow inventory, agent-hook setup, branch-protection
                   token setup.
- EVAL_HARNESS.md — runner architecture, three tolerance modes, wiring
                    your agent / LLM client, adding a case, opt-in for
                    nightly schedule.
- SECURITY.md    — threat model table + defence-in-depth ASCII map +
                    container hardening notes + explicit out-of-scope list
                    (auth, WAF, rate-limit, secret manager).
- ARCHITECTURE.md — scaffold component diagram, request lifecycle,
                    frontend lifecycle, slots that fill in as the project
                    grows.

Top-level docs:
- README.md       — what ships / quickstart / why-a-harness / docs index /
                    versions table / license.
- CONTRIBUTING.md — branching diagram, commit-prefix table, PR template
                    callouts, "adding a check" recipe.
- CLAUDE.md       — agent project instructions: read-first list, workflow,
                    code conventions, what-not-to-do, skills inventory.
- CHANGELOG.md    — release-drafter seed; first Unreleased entry summarises
                    the harness extraction.
- docs/TASKS.md   — full ticket table with phase grouping + status emoji,
                    matches the GitHub Project board.

Closes #25
Closes #26

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant