Skip to content
This repository was archived by the owner on Sep 12, 2026. It is now read-only.

feat: Add PROTO.md grounding doc + CLAUDE.md/AGENTS.md pointers - #19

Merged
mabry1985 merged 1 commit into
mainfrom
feat/bd-qlhq-add-proto-md-grounding-doc-claude-md-age
Aug 28, 2026
Merged

mabry1985 merged 1 commit into
mainfrom
feat/bd-qlhq-add-proto-md-grounding-doc-claude-md-age

Conversation

@mabry1985

Copy link
Copy Markdown
Member

Summary

Adds PROTO.md, the canonical coder-grounding doc for this repo: what it is (standalone protoAgent plugin agent_browser, thin subprocess wrappers over the vercel-labs agent-browser CLI), the stack (Python 3.12, FastAPI routers, langchain-core tools, no build step), the gate command, the host-free test patterns, the key invariants, and a file-by-file layout. CLAUDE.md and AGENTS.md are thin pointers back to it.

tests/test_docs.py is added to guard the docs — it asserts PROTO.md exists at the root and carries the gate command, test-pattern names, invariants, and file layout, and that both pointer files reference PROTO.md.

One non-doc change was required to satisfy the "gate passes" criterion: the branch's version-coherence guard (test_manifest_and_pyproject_versions_match) was already red because commit 8085474 bumped protoagent.plugin.yaml to 0.6.4 but left pyproject.toml at 0.6.3. I aligned pyproject.toml to 0.6.4 — a one-line fix that is exactly the "version must match in both files" invariant PROTO.md documents, and it turns the gate green.

Note on the changelog convention: the repo does keep a CHANGELOG.md, so rather than state "no changelog file" (which would be false in a grounding doc), PROTO.md documents the operative rule — changes are described in the PR title and commit message, with CHANGELOG.md maintained as version-keyed release notes at release time, not as a per-PR gate.

Align pyproject.toml version to 0.6.4 to match protoagent.plugin.yaml
(the version-coherence guard was red on this branch).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@mabry1985
mabry1985 merged commit 6a84f64 into main Aug 28, 2026
1 check passed
@mabry1985
mabry1985 deleted the feat/bd-qlhq-add-proto-md-grounding-doc-claude-md-age branch August 28, 2026 08:45

@protoreview protoreview Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

QA panel review — PASS

code-review-structural · head afc493ffd70b · formal

No defects found across all four LLM review angles (correctness, removed-behavior, cross-file, conventions). Overall risk is low. Nothing to fix first. The panel was unanimous in finding no issues. The structural engine failed with a gateway auth error, so structural coverage (e.g., import-graph integrity, circular-dependency detection) was subsumed by the LLM passes only — a minor gap if the diff touches module boundaries in ways the LLM finders didn't explicitly probe.

No findings — the review came back clean.

findings JSON (machine-readable)
[]

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant