docs: adoption-focused README + docs/ (CLI reference & scenario guides)#3
Merged
Conversation
Rework the README for open-source adoption and move the exhaustive detail into a docs/ set, applying Tufte information-design principles (front-load the claim, integrate examples at the point of use, tables for lookup, cut the internal-spec and wall-of-text status notes). README: - Add CI / Go Reference (godoc) / Go Report Card badges. - Lead with the value prop + a runnable 3-line example; a 4-step quickstart. - "Why chrome-cdp", a curated command taste, an AI-agent pitch, security, and a documentation index. Drops the .scratch spec note and the long Status section (superseded by the CLI reference). docs/: - cli-reference.md — every command, flag, exit code, and the output contract as lookup tables (verified against the binary's --help). - scenarios/automating-a-logged-in-web-app.md — the list→use→snap→act→verify loop end to end. - scenarios/forms-and-grids.md — label/cell addressing and batched fills. - scenarios/driving-widgets-with-select.md — menus, cascades, native selects. - using-with-ai-agents.md — the envelope/exit-code/snap design for agent tools. - README.md — docs index, with suggested future scenarios. Examples use generic placeholders; no real project/tenant/account data. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Release under MIT so the repo can be adopted once public (an unlicensed repo is "all rights reserved"). Adds the LICENSE file, a License badge, and flips the README's License section from "not yet licensed" to MIT. Co-Authored-By: Claude Opus 4.8 <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
1 participant
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.
Reworks the README for open-source adoption and adds a
docs/set, applying Tufte information-design principles — front-load the claim, integrate examples at the point of use, tables for lookup, cut the internal-spec and wall-of-text notes. Also adds an MIT license.README
.scratchspec note and the long "Status" wall (superseded by the CLI reference).docs/
cli-reference.md--helpscenarios/automating-a-logged-in-web-app.mdlist → use → snap → act → verifyloop end to endscenarios/forms-and-grids.mdscenarios/driving-widgets-with-select.md<select>susing-with-ai-agents.mdsnapmake a good agent toolREADME.mdLicense
LICENSEadded, License section + badge updated.Notes
example.com,Acme: Platform) — no real project/tenant/account data.🤖 Generated with Claude Code