Skip to content

Refresh README, add examples/, prep v0.0.6#7

Merged
jaredzwick merged 1 commit intomainfrom
hir-104-readme-refresh-v006
May 3, 2026
Merged

Refresh README, add examples/, prep v0.0.6#7
jaredzwick merged 1 commit intomainfrom
hir-104-readme-refresh-v006

Conversation

@jaredzwick
Copy link
Copy Markdown
Collaborator

Summary

  • README: replace stale 2023 integration table with honest May 2026 status (shipped / experimental / planned-with-target-release). Drop "Gmail in progress" claim — no module exists in src/.
  • README: add CI badge for existing pr_check workflow, plus Quickstart, CLI reference, and HTTP API table.
  • examples/: add echo.json (minimal) and web-summarize.json (URL input + planned action shape). Both round-trip via POST /agents.
  • CHANGELOG.md: new file, v0.0.6 section generated from git log v0.0.5..HEAD.

Source issue: HIR-104.

Out of scope (per ticket)

  • No new integration code (Gmail / SMS / Vision). README only reflects current reality.
  • No refactors.

Test plan

  • cargo build --release
  • cargo test — 2/2 passing (test_agents_index, test_database_initialization)
  • CLI smoke: pypes add agent echopypes agent echo add '{...}'pypes ls
  • HTTP smoke: pypes start --attatch -p 7990curl POST /agents against both example files → curl GET /agents round-trips ✅
  • CTO review + approve before merge (required by ticket)
  • After merge: tag v0.0.6 on main; release workflow auto-publishes the GitHub release with CHANGELOG.md notes

🤖 Generated with Claude Code

- README: replace stale 2023 integration table with honest May 2026
  status (shipped / experimental / planned with target releases). Drop
  the "Gmail in progress" claim — no module exists in src/.
- README: add CI badge for the existing pr_check workflow.
- README: add Quickstart, CLI reference, HTTP API table, and links to
  the new examples/ directory. All commands verified end-to-end against
  main (cargo test 2/2 green, CLI + HTTP round-trip).
- examples/: add echo.json (minimal hello-world) and web-summarize.json
  (illustrates URL input + planned action shape).
- CHANGELOG.md: new file, v0.0.6 section generated from
  git log v0.0.5..HEAD, plus stub for v0.0.5.

Out of scope (per HIR-104): no integration code (Gmail/SMS/Vision)
shipped, no refactors. Tag will be cut after CTO review + merge.

Co-Authored-By: Paperclip <noreply@paperclip.ing>
Copy link
Copy Markdown
Collaborator Author

@jaredzwick jaredzwick left a comment

Choose a reason for hiding this comment

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

CTO review (comment — formal approval blocked: shared GH account)

PR is well-scoped to HIR-104, CI green, mergeable, no out-of-scope creep.

What I verified:

  • Diff matches the four scope items: integration table truthing, Quickstart, examples/, CI badge. CHANGELOG generated from git log v0.0.5..HEAD.
  • BE confirmed via grep that no gmail/sms/vision modules exist — README's "in progress" framing was indeed stale. Replacement (Planned for v0.1.0/v0.2.0) is honest.
  • Agent.actions correctly labeled experimental (persisted but never dispatched).
  • Test plan executed end-to-end: cargo test 2/2, CLI flow, HTTP round-trip with both example files.
  • pr_check workflow ran on this PR and passed.

Minor observations (non-blocking):

  • Quickstart HTTP example uses port 7979 while BE's verification used 7990. Both work — 7979 matches the CLI doc default, so this is consistent.
  • --attatch typo is preserved from the existing CLI surface; correctly out of scope for a README-only PR.
  • web-summarize.json references fetch_url/summarize actions that have no executor. README is upfront about this — fine for an illustrative example.

Recommending merge. Ship decision (merge + v0.0.6 tag push) is escalated to Jared per CTO ship policy.

@jaredzwick jaredzwick merged commit 711daeb into main May 3, 2026
1 check passed
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.

2 participants