Skip to content

docs(readme): lead with block-by-block Google Doc editing through mirrors - #380

Merged
leemour merged 2 commits into
mainfrom
docs/readme-mirrors-first
Nov 17, 2026
Merged

leemour merged 2 commits into
mainfrom
docs/readme-mirrors-first

Conversation

@leemour

@leemour leemour commented Nov 17, 2026

Copy link
Copy Markdown
Member

Task

Rewrite the README so it opens with drive mirrors: an agent (or you) edits a Google Doc block by block from a local Markdown file instead of replacing the whole file. Bring it to tg-cli's order per cli-base WC-DOC-7.

Why

Most readers open only the README. The block-level editing gain was buried in docs/mirrors.md.

What

  • New first screen: banner, hero line, links row, badges, three bold gains, "What you get" with an invented exchange, "Why drive" with the link to docs/compare.md.
  • Quick start sets up a mirror (session start --grant write, mirrors add, mirrors sync). "Use it with your agent" follows. The existing sections keep their content, with semicolons and long dashes rewritten.
  • Contrast uses only verified facts: Google lets programs change a Markdown file in Drive only by replacing all of it (cli-testing native-markdown). Claude's built-in Google Drive connector's update_file changes metadata only (tool schema, checked 2026-11-17). Nothing about Codex: no official documentation found.
  • docs/compare.md: one line pointing the "edit a Doc from Markdown" job to the mirrors guide. The comparison table itself lives on wirecat.dev.
  • No changelog fragment: README and docs only.

Testing

pnpm docs:check (docs check, cspell, rumdl, markdownlint) and pnpm docs:spell pass. Every link target of the old README is still present.

🤖 Generated with Claude Code

leemour and others added 2 commits November 17, 2026 12:20
…rors

The README now opens with what the owner calls drive's main gain: an agent or a
person edits a local Markdown file, and `mirrors sync` sends only the changed
blocks to the Google Doc, merges colleagues' edits made elsewhere and reports a
part changed on both sides.

It follows tg-cli's order (cli-base WC-DOC-7): banner, hero line, links and
badges, three gains, "What you get" with an example, "Why drive", quick start,
agent setup, then the existing sections. Every claim about mirrors is backed by
src/mirror-docs.ts, its tests, cli-core's block merge tests or the cli-testing
drive-push and native-markdown measurements. The other existing link targets
stay. docs/compare.md gains one line pointing the "edit a Doc from Markdown"
job to the mirrors guide.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…c and edit every line

The owner's wording. banner.html and render.ts come from cli-base's banner template.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@leemour
leemour merged commit aee186e into main Nov 17, 2026
8 checks passed
@leemour
leemour deleted the docs/readme-mirrors-first branch November 17, 2026 16:11
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