Skip to content

docs(readme): tighten the agent quickstart#192

Merged
benvinegar merged 3 commits intomainfrom
docs/agent-quickstart-followup
Apr 10, 2026
Merged

docs(readme): tighten the agent quickstart#192
benvinegar merged 3 commits intomainfrom
docs/agent-quickstart-followup

Conversation

@benvinegar
Copy link
Copy Markdown
Member

Summary

  • tighten the README agent quickstart into a short 3-step flow with a sample prompt
  • remove the duplicated advanced agent section from the README and keep the detailed guide in docs/agent-workflows.md
  • add a short note that hunk skill path lands in Hunk 0.10.0 and is not available yet

Testing

  • docs-only change
  • formatting already 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 docs-only PR tightens the README agent quickstart into a concise 3-step flow with a sample prompt, removes a duplicate advanced section from the README (deferring to docs/agent-workflows.md), and adds a consistent availability note that hunk skill path ships in Hunk 0.10.0.

Confidence Score: 5/5

Safe to merge — docs-only change with no functional impact.

All findings are P2 style suggestions; no correctness, data, or runtime concerns exist in a documentation-only PR.

No files require special attention.

Important Files Changed

Filename Overview
README.md Tightened agent quickstart to a 3-step flow with sample prompt and availability note; step ordering is inverted relative to the detailed guide in docs/agent-workflows.md.
docs/agent-workflows.md Adds the same hunk skill path availability note (0.10.0) as the README; content and links look correct.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[User opens README quickstart] --> B["Step 1: Load Hunk review skill\nskills/hunk-review/SKILL.md"]
    B --> C["Step 2: Open Hunk in another terminal\nhunk diff / hunk show"]
    C --> D["Step 3: Ask agent to use the skill"]
    D --> E[Agent controls live Hunk session]

    F[User reads docs/agent-workflows.md] --> G["Step 1: Open Hunk in a terminal\nhunk diff / hunk show"]
    G --> H["Step 2: Load Hunk review skill\n../skills/hunk-review/SKILL.md"]
    H --> I["Step 3: Ask agent to use the skill"]
    I --> E

    style B fill:#ffe0b2
    style G fill:#e8f5e9
    style C fill:#ffe0b2
    style H fill:#e8f5e9
Loading

Reviews (1): Last reviewed commit: "docs(readme): tighten the skill-path not..." | Re-trigger Greptile

Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
@benvinegar benvinegar merged commit 3ab9663 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