Skip to content

docs: lead the README with the live review loop - #121

Merged
scott merged 1 commit into
mainfrom
docs/120-readme-review-loop
Sep 14, 2026
Merged

scott merged 1 commit into
mainfrom
docs/120-readme-review-loop

Conversation

@scott

@scott scott commented Sep 14, 2026

Copy link
Copy Markdown
Collaborator

Rewrite the CLI README lead to match the shipped Gander story: a live review loop for markdown an agent is still writing, not “share markdown.”

  • Product job first, then Watch → Comment → Act
  • For authors (pain is screenshare / early commit / reviewing alone in the IDE) and a short For reviewers note (@agent summons)
  • Comments and the agent after Share on gander.md, matching comments and MCP
  • gander comments and gander mcp / gander mcp install in the subcommand list
  • Existing technical how-it-works renamed to How the CLI works so it does not collide with the new H2
  • Local gander --watch vs hosted gander watch kept as-is

Copy-only. Does not change CLI code, flags, install commands, config JSON, release scripts, or man-page pointers. Does not run gh repo edit (GitHub About is a post-merge checkbox on the issue).

Sibling README issues (same copy pass, one per repo):

Closes #120

Rewrite the README top around Watch → Comment → Act. Add For authors /
For reviewers, a Comments and the agent section, and the missing
comments/MCP subcommands. Rename the technical how-it-works heading so
it does not collide with the new product loop.

Closes #120
@scott

scott commented Sep 14, 2026

Copy link
Copy Markdown
Collaborator Author

@scott
scott merged commit 9d67daa into main Sep 14, 2026
1 check 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.

Lead the README with the live review loop

1 participant