Skip to content

docs(readme): move agent workflow details into docs#191

Merged
benvinegar merged 3 commits intomainfrom
docs/agent-workflows-guide
Apr 10, 2026
Merged

docs(readme): move agent workflow details into docs#191
benvinegar merged 3 commits intomainfrom
docs/agent-workflows-guide

Conversation

@benvinegar
Copy link
Copy Markdown
Member

Summary

  • move the detailed session and agent workflow reference out of README.md into docs/agent-workflows.md
  • keep the README focused on the high-level agent setup flow: load the skill, get the absolute path with hunk skill path, and use a starter prompt
  • link from the README to the dedicated docs page for the full live-session and --agent-context guide

Testing

  • docs-only change
  • formatting applied via oxfmt

This PR description was generated by Pi using OpenAI o3

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps bot commented Apr 10, 2026

Greptile Summary

This PR extracts the detailed agent workflow reference from README.md into a new docs/agent-workflows.md file, keeping the README focused on the high-level setup flow (load the skill, get the absolute path via hunk skill path, use a starter prompt) and linking out for deeper reference. The relative links from docs/agent-workflows.md back to ../skills/… and ../examples/… are structurally correct.

Confidence Score: 5/5

Docs-only reorganization with correct links and no functional changes — safe to merge.

All findings are P2 style suggestions (link display text cosmetics). No logic, correctness, or functional issues exist in this documentation-only PR.

No files require special attention.

Important Files Changed

Filename Overview
README.md Agent workflow section trimmed to high-level setup with two cross-references to docs/agent-workflows.md; content is accurate and links are correct
docs/agent-workflows.md New file containing the full live-session and --agent-context reference; relative links use ../ prefix in both the URL and the display text, which works but is slightly awkward to read

Sequence Diagram

sequenceDiagram
    participant Agent as Coding Agent
    participant Skill as skills/hunk-review/SKILL.md
    participant CLI as hunk CLI
    participant Daemon as loopback daemon
    participant TUI as Live Hunk TUI

    Agent->>CLI: hunk skill path
    CLI-->>Agent: /absolute/path/to/SKILL.md
    Agent->>Skill: load skill file
    Skill-->>Agent: session commands + protocols

    Note over TUI,Daemon: User opens Hunk in another window
    TUI->>Daemon: register session on start

    Agent->>CLI: hunk session list
    CLI->>Daemon: find registered sessions
    Daemon-->>CLI: session list
    CLI-->>Agent: active sessions

    Agent->>CLI: hunk session context --repo .
    CLI->>Daemon: route to matching session
    Daemon->>TUI: request context
    TUI-->>Daemon: file/hunk structure
    Daemon-->>CLI: review context JSON
    CLI-->>Agent: structured review context

    Agent->>CLI: hunk session comment add --repo . --file README.md --new-line 103 --summary "..."
    CLI->>Daemon: route comment to session
    Daemon->>TUI: apply inline comment
    TUI-->>Agent: comment visible in live window
Loading

Reviews (1): Last reviewed commit: "docs(readme): move agent workflow detail..." | Re-trigger Greptile

@benvinegar benvinegar merged commit 199b271 into main Apr 10, 2026
2 checks 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.

1 participant