Skip to content

docs: add PR review guides, rework quickstart, slim down installation#6532

Merged
teknium1 merged 1 commit into
mainfrom
hermes/hermes-1f1c004b
Apr 19, 2026
Merged

docs: add PR review guides, rework quickstart, slim down installation#6532
teknium1 merged 1 commit into
mainfrom
hermes/hermes-1f1c004b

Conversation

@teknium1

@teknium1 teknium1 commented Apr 9, 2026

Copy link
Copy Markdown
Contributor

Summary

Integrates contest-winning docs guides and reorganizes the getting-started section.

New guides (2 files)

  • GitHub PR Review Agent (cron-based) — salvaged from PR docs: add GitHub PR Review Agent tutorial #5836 by @dieutx
    • Polls repos on a schedule, delivers reviews to Telegram/Discord/local
    • Teaches skill authoring + memory for consistent reviews
    • No server or public endpoint needed
  • Webhook-Based PR Reviews — salvaged from PR docs: Using Webhooks with GitHub-Guide #6503 by @gaijinkush
    • Real-time reviews triggered by GitHub webhook events
    • Documents the webhook adapter config (previously undocumented)
    • Covers security (HMAC, prompt injection), GitLab support, troubleshooting
  • Both guides cross-link each other (cron vs webhook choice)

Quickstart rework

Integrated best content from PR #5744 by @aidil2105:

  • Decision table ('The fastest path') for different user goals
  • Common failure modes table with causes and fixes
  • Recovery toolkit sequence (hermes doctor → model → setup → ...)
  • Session lifecycle verification step
  • Better first-chat guidance with specific example prompts
  • Removed duplicated provider table (full table lives in installation.md / providers page)

Installation cleanup

  • Removed 10-step manual/dev install section (~170 lines)
  • Already covered in developer-guide/contributing.md — linked there instead
  • Installation page now focused: automated installer + prerequisites + troubleshooting

Sidebar

  • Added both new guides to sidebars.ts (no existing entries removed)

Build verified

npx docusaurus build passes (only pre-existing broken anchor warnings on hooks page)

Closes: salvages from #5836, #6503, #5744

Adds two complementary GitHub PR review guides from contest submissions:
- Cron-based PR review agent (from PR #5836 by @dieutx) — polls on a
  schedule, no server needed, teaches skills + memory authoring
- Webhook-based PR review (from PR #6503 by @gaijinkush) — real-time via
  GitHub webhooks, documents previously undocumented webhook feature
Both guides are cross-linked so users can pick the approach that fits.

Reworks quickstart.md by integrating the best content from PR #5744
by @aidil2105:
- Opinionated decision table ('The fastest path')
- Common failure modes table with causes and fixes
- Recovery toolkit sequence
- Session lifecycle verification step
- Better first-chat guidance with example prompts

Slims down installation.md:
- Removes 10-step manual/dev install section (already covered in
  developer-guide/contributing.md)
- Links to Contributing guide for dev setup
- Keeps focused on the automated installer + prerequisites + troubleshooting
@teknium1 teknium1 force-pushed the hermes/hermes-1f1c004b branch from c8fe2cd to 965bf54 Compare April 19, 2026 12:24
@teknium1 teknium1 merged commit 37524a5 into main Apr 19, 2026
2 of 5 checks passed
@teknium1 teknium1 deleted the hermes/hermes-1f1c004b branch April 19, 2026 12:30
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