Skip to content

docs: streamline the agent workflows guide - #635

Open
benvinegar wants to merge 1 commit into
mainfrom
claude/agent-workflows-guide-cleanup
Open

docs: streamline the agent workflows guide#635
benvinegar wants to merge 1 commit into
mainfrom
claude/agent-workflows-guide-cleanup

Conversation

@benvinegar

Copy link
Copy Markdown
Member

Rewrites docs/agent-workflows.md from 158 lines to ~95 without losing information.

  • The old guide re-taught the full hunk session command surface three times ("The commands you will use most", "Session targeting", "Practical defaults"), duplicating the generated SKILL.md. It now shows one compact typical-review block and defers full syntax, advanced reload targeting, and error remedies to the skill.
  • Fixes the stale hunk mcp serve reference — the canonical command is hunk daemon serve (mcp serve remains only as an alias).
  • Keeps the loopback-daemon explanation and the sandbox curl probe, plus the --agent-context and STML sections in tightened form, and links the hosted agents guide on hunk.dev.
  • Empty changeset (docs-only).

The skillDocument.test.ts guard (which restricts this file to declared agent-surface flags) passes, and every claim — daemon auto-registration, port/path/action of the probe, STML launch-authority semantics — was fact-checked against the session/broker source.

🤖 Generated with Claude Code

https://claude.ai/code/session_01KHY9ReVesQXwKdRU47MwJ9


Generated by Claude Code

The guide repeated the generated skill's command reference three times
over (commands, session targeting, and practical-defaults sections) and
still pointed at the legacy `hunk mcp serve` alias. It now defers
command details to the skill, uses the canonical `hunk daemon serve`,
and reads as a short human-facing overview of the two agent workflows.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01KHY9ReVesQXwKdRU47MwJ9
@vercel

vercel Bot commented Jul 29, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
hunk-web Ready Ready Preview Jul 29, 2026 12:57am

Request Review

Comment thread docs/agent-workflows.md
Comment on lines +89 to +90
Plain-text `summary` fields stay required as the fallback, and a reload cannot
change the launch opt-in. Agents check support via `experimentalFeatures` in

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

P1 Reload changes STML enablement

When an existing session is reloaded, the registration derives experimentalFeatures from the replacement command rather than preserving the launch setting. Reloading without --experimental therefore disables STML despite this statement, causing agents to incorrectly assume markup remains supported.

Prompt To Fix With AI
This is a comment left during a code review.
Path: docs/agent-workflows.md
Line: 89-90

Comment:
**Reload changes STML enablement**

When an existing session is reloaded, the registration derives `experimentalFeatures` from the replacement command rather than preserving the launch setting. Reloading without `--experimental` therefore disables STML despite this statement, causing agents to incorrectly assume markup remains supported.

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

@greptile-apps

greptile-apps Bot commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

Streamlines the agent-workflows guide while preserving its primary workflows.

  • Replaces repeated session-command documentation with a compact review example and links to the generated skill.
  • Updates manual daemon startup guidance to use hunk daemon serve.
  • Condenses loopback troubleshooting, agent-context, and experimental STML guidance.
  • Adds an empty documentation-only changeset.

Confidence Score: 4/5

The documentation should not merge until its reload/STML statement matches the session registration behavior.

Reload derives experimental features from the replacement command, so omitting or adding --experimental changes STML support despite the guide claiming the opt-in is immutable.

Files Needing Attention: docs/agent-workflows.md

Important Files Changed

Filename Overview
docs/agent-workflows.md The streamlined workflow and daemon instructions are consistent with the implementation, but the STML section incorrectly says reload cannot change experimental enablement.
.changeset/agent-workflows-guide-cleanup.md Adds an appropriate empty changeset for a documentation-only update.
Prompt To Fix All With AI
### Issue 1
docs/agent-workflows.md:89-90
**Reload changes STML enablement**

When an existing session is reloaded, the registration derives `experimentalFeatures` from the replacement command rather than preserving the launch setting. Reloading without `--experimental` therefore disables STML despite this statement, causing agents to incorrectly assume markup remains supported.

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

Reviews (1): Last reviewed commit: "docs: streamline the agent workflows gui..." | Re-trigger Greptile

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