Skip to content

docs: refresh and trim AGENTS.md, cover v1.24.0 in README - #129

Merged
jkyberneees merged 1 commit into
mainfrom
docs/agents-readme-refresh
Aug 8, 2026
Merged

docs: refresh and trim AGENTS.md, cover v1.24.0 in README#129
jkyberneees merged 1 commit into
mainfrom
docs/agents-readme-refresh

Conversation

@jkyberneees

@jkyberneees jkyberneees commented Aug 8, 2026

Copy link
Copy Markdown
Contributor

Summary

Docs-only refresh after the v1.24.0 extension MVP. No code changes.

AGENTS.md — trimmed 60 KB → 20 KB (−67%), updated to v1.24.0:

  • Security Architecture: ~70 exhaustive bullets condensed into thematic layers (untrusted-content boundary, provenance gates, danger classifier, approval friction, sub-agent caps, MCP hardening, config trust split, serve/network, budgets/events/refs, resource bounds, Telegram, redaction) — with docs/SECURITY.md named as the normative full list and `security_report_validation_test.go` as the regression bar.
  • Source Layout updated: `internal/artifact`, `internal/events`, `internal/budget`, `cmd/odek/external_ref.go`, /api/limits on serve, approval-key coverage note.
  • New "Extension capabilities (odek-extension/v1)" section summarizing the five MVP features.
  • Testing: new fuzz targets (artifact envelope/validation, event JSON, external refs, limits clamp) + CI lint/vuln gates; release process noted as tag-driven.

README.md — v1.24.0 coverage + one correctness fix:

  • Fix: config priority chain was documented as four layers — now five, with `~/.odek/secrets.env` first (matches docs/CONFIG.md).
  • New strategic feature: Execution Budgets & Runtime Events (budget flags, exit code 4, `--events-jsonl`, `EventHandler`, `GET /api/limits`).
  • MCP section: per-server limits + validated artifact references + EXTENSIONS.md contract pointer.
  • Cheatsheet: `--events-jsonl`, `--external-ref`, and the five budget flags.
  • Docs table gains EXTENSIONS.md; API snippet lists `EventHandler`/`ExternalRefs`/`Limits`.

Verification

  • Fuzz target names referenced in AGENTS.md verified against the tree.
  • Docs-only: `go build ./...` unaffected; no Go files touched.

@jkyberneees
docs: refresh and trim AGENTS.md, cover v1.24.0 in README
a2e4300 
AGENTS.md: 60 KB -> 20 KB. The Security Architecture section is
condensed from ~70 exhaustive bullets into thematic layers with a
pointer to docs/SECURITY.md (the normative list); Source Layout, loop
behavior, and testing sections are tightened without losing pointers.
Adds the v1.24.0 extension surface (mcpclient limits, artifact/events/
budget packages, external refs, /api/limits, init template, new fuzz
targets, CI lint/vuln gates, tag-driven releases).

README.md: fix the config priority chain (five layers, secrets.env
first); document execution budgets + runtime events + /api/limits as a
strategic feature; extend the MCP section with per-server limits and
artifact refs; add --events-jsonl/--external-ref/budget flags to the
cheatsheet; add docs/EXTENSIONS.md to the docs table; list the new
Config fields in the API snippet.
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Aug 8, 2026 •
edited
Loading

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs		 odek a2e4300 Commit Preview URL

Branch Preview URL		 Aug 08 2026, 09:25 AM

@jkyberneees
jkyberneees merged commit a04e211 into main Aug 8, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@jkyberneees