Skip to content

docs: README audit + peek extension now live on the Chrome Web Store#106

Merged
harry-harish merged 1 commit into
mainfrom
docs/readme-audit-cws-golive
Jun 23, 2026
Merged

docs: README audit + peek extension now live on the Chrome Web Store#106
harry-harish merged 1 commit into
mainfrom
docs/readme-audit-cws-golive

Conversation

@harry-harish

@harry-harish harry-harish commented Jun 23, 2026

Copy link
Copy Markdown
Member

Summary

Documentation-only pass, two rounds, no code changes.

1. README audit — a grounded sweep of the canonical READMEs against actual source:

  • peek is no longer documented as read-only. The root + @peekdev/cli + @peekdev/extension READMEs now state peek reads recorded sessions and, with explicit per-origin consent, drives the live page, with the five-level permission model (0 Off → 1 Read-only → 2 Suggest → 3 Act-with-confirm → 4 YOLO, default Level 1). Tool count corrected to 16 (adds the live ref-tagged page view + the act/handoff tools), grounded in packages/peek-mcp/src/mcp/server.ts.
  • @peekdev/cli command block rewritten to match the real CLI (peek audit log + flags, sessions flags, markdown export default, --format html flagged reserved/unimplemented).
  • tracelane adapter accuracy: documented @tracelane/wdio's default-on security + consolePluginOptions, the shipped tracelane index subcommand, and @tracelane/report's security panel + buildReport options arg; dropped the invented "Q4 2026" Cypress date.
  • Replaced the stock Vite-template peek-todomvc-demo README with real content; assorted link/markdown fixes.

2. CWS go-live — the peek Chrome MV3 extension is now live on the Chrome Web Store (https://chromewebstore.google.com/detail/peek/dmgpmkeneheenpdnfmpjjahnkknkaejb). Flipped ~21 docs (root + peek READMEs, SUPPORTED.md, 11 recipe prerequisites, distribution playbooks) from "submission pending / load unpacked" → the live listing as the primary install, with "load unpacked" demoted to a contributor/local-build fallback. @peekdev/extension's npm/private status is unchanged.

Scope

34 files, +249 / −142 — all .md docs + 2 changesets (readme-act-surface-and-cli-accuracy, peek-extension-cws-live; patch bumps for the published packages whose README content changed). No source, no package.json, no badge changes.

Verification

Each README was audited + fixed against source, then adversarially re-verified per file (the verify pass caught and corrected a semantic inversion in the @tracelane/security suppression-file docs). The CWS flip was checked to use the canonical listing URL everywhere, never the unrelated "Peek Extension" (Piiq Technologies) look-alike, and to leave npm/private status intact.

Follow-ups (intentionally NOT in this PR)

  • docs/peek/THREATMODEL.md is still a "stub… to be filled in before public Chrome Web Store submission," yet the extension shipped to CWS — a launch-hygiene gap to resolve separately (not fabricating threat-model content here).
  • The mcp.so / cursor-directory submission docs still carry "DO NOT SUBMIT until Phase 5" — a launch-sequencing decision, left as-is.

🤖 Generated with Claude Code

Summary by CodeRabbit

Release Notes

  • New Features

    • Peek Chrome extension now available on the Chrome Web Store for easier installation.
    • Added tracelane index subcommand to generate consolidated HTML index pages from report directories.
    • New security-hygiene analysis panel in tracelane reports.
    • New configuration options across peek and tracelane packages.
  • Documentation

    • Updated installation instructions and prerequisites across recipe guides.
    • Clarified CLI commands, options, and behaviors for peek and tracelane.
    • Expanded configuration documentation for adapter and report packages.

Round 1 (README audit): correct peek's MCP surface (read + consent-gated act, 16 tools incl. live page view), rewrite the peek CLI command block to match the actual CLI, document tracelane adapter options (wdio security/consolePluginOptions, the cli index subcommand, report security panel + buildReport options), replace the stock Vite-template demo README with real content, drop the invented Q4 2026 Cypress date, and fix assorted links/markdown across package READMEs.

Round 2 (CWS go-live): the peek Chrome MV3 extension is now live on the Chrome Web Store; flip ~21 docs (root + peek READMEs, SUPPORTED.md, 11 recipe prerequisites, distribution playbooks) from 'submission pending / load unpacked' to the live listing as the primary install, with unpacked demoted to a contributor fallback. The @peekdev/extension npm/private status is unchanged.

Docs-only; no code change. Two changesets included (patch bumps for the published packages whose README content changed).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: harry-harish <22562634+harry-harish@users.noreply.github.com>
@coderabbitai

coderabbitai Bot commented Jun 23, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 0d3221c7-e19f-40b2-bf7b-5daee988ae2c

📥 Commits

Reviewing files that changed from the base of the PR and between a02c864 and cc1d428.

📒 Files selected for processing (34)
  • .changeset/peek-extension-cws-live.md
  • .changeset/readme-act-surface-and-cli-accuracy.md
  • README.md
  • SUPPORTED.md
  • apps/peek-docs/public/recipes/assets/README.md
  • apps/peek-docs/src/content/recipes/claude-code-on-staging.md
  • apps/peek-docs/src/content/recipes/clone-a-web-app-with-peek.md
  • apps/peek-docs/src/content/recipes/compare-staging-and-prod-page-versions.md
  • apps/peek-docs/src/content/recipes/generate-playwright-repro-from-real-browser-session.md
  • apps/peek-docs/src/content/recipes/let-cursor-see-real-network-calls.md
  • apps/peek-docs/src/content/recipes/reproduce-bug-from-teammate-peek-session.md
  • apps/peek-docs/src/content/recipes/security-review-flow-with-ai-agent.md
  • apps/peek-docs/src/content/recipes/set-up-peek-with-claude-code.md
  • apps/peek-docs/src/content/recipes/set-up-peek-with-cline-windsurf-codex.md
  • apps/peek-docs/src/content/recipes/set-up-peek-with-cursor.md
  • apps/peek-docs/src/content/recipes/validate-multi-step-authenticated-checkout.md
  • apps/peek-todomvc-demo/README.md
  • apps/tracelane-docs/public/recipes/assets/README.md
  • assets/README.md
  • docs/peek/distribution/README.md
  • docs/peek/distribution/cursor-directory-submission.md
  • docs/peek/distribution/cws-submission.md
  • docs/peek/distribution/mcp-so.md
  • docs/peek/distribution/modelcontextprotocol-servers.md
  • docs/qa/fixtures/tracelane-demo/README.md
  • packages/peek-cli/README.md
  • packages/peek-extension/README.md
  • packages/peek-mcp/README.md
  • packages/rrweb-core/README.md
  • packages/tracelane-cli/README.md
  • packages/tracelane-core/README.md
  • packages/tracelane-report/README.md
  • packages/tracelane-security/README.md
  • packages/tracelane-wdio/README.md

📝 Walkthrough

Walkthrough

Docs-only PR reflecting the Peek Chrome extension going live on the Chrome Web Store: all install instructions, distribution trackers, and recipe prerequisites are updated from "submission pending / load unpacked" to prioritize the Web Store URL with a local-build fallback. Separately, tracelane package READMEs are corrected to document the tracelane index subcommand, the advisory security-hygiene panel, BuildReportOptions, new wdio options, and accurate CLI command surfaces.

Changes

Peek Chrome Web Store Launch

Layer / File(s) Summary
Distribution tracking docs marked DONE
.changeset/peek-extension-cws-live.md, docs/peek/distribution/README.md, docs/peek/distribution/cws-submission.md, docs/peek/distribution/cursor-directory-submission.md, docs/peek/distribution/mcp-so.md, docs/peek/distribution/modelcontextprotocol-servers.md
Changeset entries and all distribution tracking docs updated to reflect the CWS listing as live on 2026-06-21, with verification commands, the live URL, and republish steps for @peekdev/mcp.
Package READMEs updated for CWS availability
packages/peek-extension/README.md, packages/peek-mcp/README.md, packages/peek-cli/README.md
peek-extension README rewrites install flow to lead with Web Store and adds a new "Agent control (trust dial)" section with five permission levels. peek-mcp and peek-cli READMEs update install wording, bump MCP tool count from 14 to 16, and rewrite the Commands block to match actual CLI flags.
Root and support docs updated
README.md, SUPPORTED.md, assets/README.md, apps/peek-todomvc-demo/README.md
Root README adds the five-level permission model description and marks the extension as live; SUPPORTED.md drops "Phase 5 launch gate"; assets README corrects GIF size estimate and command description; todomvc-demo README replaced with a purpose-written artifact README.
Recipe prerequisites updated across peek-docs
apps/peek-docs/src/content/recipes/*, apps/peek-docs/public/recipes/assets/README.md
All ten recipe files have the Chrome/peek prerequisite bullet changed from "load unpacked only" to "install from Chrome Web Store or load unpacked from packages/peek-extension/chrome-mv3/"; verifier note clarifies which published recipes require hero images.

Tracelane Docs Accuracy Pass

Layer / File(s) Summary
Security panel and buildReport options documented
packages/tracelane-report/README.md, packages/tracelane-security/README.md, packages/tracelane-wdio/README.md, .changeset/readme-act-surface-and-cli-accuracy.md
tracelane-report README documents the advisory security-hygiene panel and the optional BuildReportOptions third argument (enforceSizeBudget, footer, security, securitySuppress). tracelane-security adds disable/suppress guidance. tracelane-wdio adds consolePluginOptions and security option rows to the Options table.
tracelane index subcommand documented
packages/tracelane-cli/README.md
New README section documents the tracelane index <dir> subcommand with --out, --sort, --title options, a usage example, and exit codes.
Roadmap, QA fixtures, and asset docs updated
packages/tracelane-core/README.md, docs/qa/fixtures/tracelane-demo/README.md, apps/tracelane-docs/public/recipes/assets/README.md, packages/rrweb-core/README.md
Cypress adapter status changed from "planned Q4 2026" to "on the roadmap"; QA fixture README bumps pinned alpha version and rewrites the network-capture note to reflect in-page default capture; tracelane-docs recipe assets README expands the published hero image list.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

  • Cubenest/rrweb-stack#68: Introduced the @tracelane/security advisory panel and its security: false / suppress-file configuration that this PR documents in tracelane-report, tracelane-security, and tracelane-wdio READMEs.
  • Cubenest/rrweb-stack#76: Added the clone-a-web-app-with-peek.md recipe whose Chrome prerequisite bullet this PR updates to reflect Chrome Web Store availability.
  • Cubenest/rrweb-stack#94: Prior corrections to MCP tool counts and consent/permission model docs in packages/peek-cli/README.md that this PR further updates (16 tools, rewritten Commands block).
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and accurately summarizes the pull request's main objective: documenting the launch of the peek Chrome extension to the Chrome Web Store alongside a comprehensive README audit.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-audit-cws-golive

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@harry-harish harry-harish merged commit 5c736d4 into main Jun 23, 2026
5 checks passed
@harry-harish harry-harish deleted the docs/readme-audit-cws-golive branch June 23, 2026 16:48
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