Repository navigation
docs(readme): lead with block-by-block Google Doc editing through mirrors - #380
Merged
Merged
Conversation
…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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
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.update_filechanges metadata only (tool schema, checked 2026-11-17). Nothing about Codex: no official documentation found.Testing
pnpm docs:check(docs check, cspell, rumdl, markdownlint) andpnpm docs:spellpass. Every link target of the old README is still present.🤖 Generated with Claude Code