mirror of
https://github.com/paperclipai/paperclip-docs.git
synced 2026-11-07 06:16:07 -10:00
DottaandPaperclip
29a78936e5
## Thinking Path > - Paperclip runs agent work as tasks and runs. > - The experimental GitHub chat connector lets GitHub conversations and PR events enter those tasks. > - Installing an App, scheduling reviews, and requiring a passing check are independent choices. > - Readers need both that explanation and a concrete setup tutorial. > - These guides pair the mental model with a Storybook reviewer that can be tested from failure to success. ## What Changed - Group all four GitHub pages under an expandable GitHub sidebar section, with matching breadcrumbs. - Add **Understanding GitHub PR review bots**, preserving the conversational explanation of installation, triggers, scores, checks, and formal reviews. - Add a separate **Set up a GitHub review bot** tutorial with a copyable Storybook instruction, agent/runtime prerequisites, App registration and installation, repository selection, identity linking, and required-check configuration. - Mark both pages as experimental chat documentation and cross-link them. Update the older GitHub pages to remove conflicting legacy setup advice. - Include four real setup UI screenshots in both themes, using explicitly labeled demo responses. Register all eight images for reproducible capture and source-change tracking. - Add a screenshot-only fixture and small capture helpers for native selects, required content, and a configurable local port. ## Verification - Latest-head GitHub `docs-test` and Cloudflare Pages checks passed at `b4e7943f8e77bc3320ea6eb0379dd1ff65f87a98`. - Deployed preview browser-checked: [understanding review bots](https://5e364a56.paperclip-docs-74t.pages.dev/connectors/understanding-github-review-bots/) and [setup tutorial](https://5e364a56.paperclip-docs-74t.pages.dev/connectors/github-review-bot-setup/). - GitHub sidebar collapse/expand and navigation between nested pages checked in the embedded browser. - Both pages checked in the embedded browser. Followed the cross-links in both directions and verified all four images load in light and dark themes. - All eight screenshots captured from the actual UI at Paperclip revision `7ba761fe007bb798400d3e62346fa964f607f0f8`. No live GitHub credentials or agent runs are represented by these fixtures. - `npm run sync:lint-links`, `npm run sync:verify-nav`, and `npm run sync:verify-screenshots` passed. Navigation reports only the three pre-existing unlisted/orphan pages. - `npm run docs:build` and the complete `npm run docs:test` suite passed, including static routes, sitemap history, asset fingerprints, navigation, crawlable links, source blocks, 1,945 link-resolution checks, and SEO metadata. - Reviewed the current GitHub documentation for required checks, expected App sources, and neutral results. ## Risks The chat feature is experimental and the UI may change. Screenshot dependencies and capture commands are recorded for refreshes. The tutorial distinguishes illustrative UI captures from the live acceptance tests readers must perform. This changes documentation and its screenshot pipeline only. ## Model Used OpenAI GPT-6 through Codex, using repository tools and the embedded browser. The precise serving model variant and context-window size were not exposed. ## Checklist - [x] Both requested pages exist and cross-reference each other. - [x] Both identify the experimental chat feature. - [x] Screenshots include light and dark themes with capture provenance. - [x] Documentation build and targeted verification passed. - [x] Complete docs test suite and PR checks passed. --------- Co-authored-by: Paperclip <[email protected]>