Skip to content

[Growth] Decide whether README real-session screenshots are acceptable#153

Closed
luoyuctl wants to merge 2 commits intomasterfrom
growth/140-redacted-readme-assets
Closed

[Growth] Decide whether README real-session screenshots are acceptable#153
luoyuctl wants to merge 2 commits intomasterfrom
growth/140-redacted-readme-assets

Conversation

@luoyuctl
Copy link
Copy Markdown
Owner

@luoyuctl luoyuctl commented May 4, 2026

Closes #140

Summary

  • Replaces the public README screenshot set with generated demo/redacted fixture assets.
  • Updates English and Chinese README copy from a real local run to a demo fixture path.
  • Points the site and launch-kit preview references at the redacted demo assets while keeping the Pages compatibility asset synthetic.

User-facing value

New users can inspect the README and site screenshots without seeing private prompts, code, local paths, real session identifiers, or personal/work usage metrics.

Adoption rationale

The public asset set now supports the local-first privacy promise directly: the screenshots demonstrate the workflow without depending on private local history.

Scope

  • README.md
  • README.zh-CN.md
  • docs/launch-kit.md
  • site/index.html
  • assets/readme-*.png
  • assets/readme-demo-run.gif
  • assets/hero-banner.png

Test plan

  • git diff --check
  • markdownlint README.md docs/**/*.md || true (local markdownlint is not installed)
  • go test ./...
  • go build -o /tmp/agenttrace-growth-check ./cmd/agenttrace
  • /tmp/agenttrace-growth-check --doctor
  • AGENTTRACE_BIN=/tmp/agenttrace-growth-check AGENTTRACE_CI_OUT=/tmp/agenttrace-growth-ci /bin/bash scripts/ci/check-output-contract.sh
  • AGENTTRACE_BIN=/tmp/agenttrace-growth-check AGENTTRACE_CI_OUT=/tmp/agenttrace-growth-ci /bin/bash scripts/ci/check-deterministic-output.sh
  • AGENTTRACE_BIN=/tmp/agenttrace-growth-check AGENTTRACE_CI_OUT=/tmp/agenttrace-growth-ci /bin/bash scripts/ci/check-report-semantics.sh
  • /bin/bash scripts/ci/check-release-surfaces.sh
  • AGENTTRACE_BIN=/tmp/agenttrace-growth-check AGENTTRACE_CI_OUT=/tmp/agenttrace-growth-ci /bin/bash scripts/ci/check-docs-commands.sh
  • /bin/bash scripts/ci/check-pages-artifact.sh site
  • OCR scan over README/site assets for real IDs, legacy cost wording, local paths, and old metrics

Note: invoking scripts through env bash hit a local Homebrew bash/readline dynamic-linker issue, so the same scripts were rerun explicitly with /bin/bash and passed.

Safety checklist

  • No Go source changes.
  • No parser or quality专项 changes.
  • No workflow changes.
  • No release, tag, package, or merge action.
  • No create/drop database logic.
  • Public README screenshots contain generated demo/redacted data instead of private local session evidence.

@luoyuctl
Copy link
Copy Markdown
Owner Author

luoyuctl commented May 4, 2026

Quality Gatekeeper Review

Verdict: BLOCK
Risk: High
Lane: growth
Scope: public README/site asset replacement; post-#140 privacy/public-content blocker.

Checks:

  • Scope is clear
  • Protected core files unchanged
  • No Go/parser/source changes
  • No obvious prompt/code/secret/full local path found by text scan/OCR
  • README/README.zh-CN copy now states generated demo data
  • GitHub CI: SUCCESS (Test and build)
  • Local validation passed
  • Auto-merge eligible: no, High-risk public README/site/assets surface

GitHub state:

Changed-files risk:

  • High. This changes README, README.zh-CN, public binary assets, docs/launch-kit.md, and site/index.html.
  • OCR over the new README/site assets showed synthetic/demo wording and did not show the previously observed real aggregate metrics, real session ids, or legacy cost wording.
  • assets/readme-real-overview.png is still present as a compatibility asset and copied by .github/workflows/pages.yml; OCR shows it is synthetic, but the public compatibility decision should be explicit before merge.

Commands run:

  • gh pr view 153 --repo luoyuctl/agenttrace --json number,title,body,labels,isDraft,mergeStateStatus,statusCheckRollup,files,closingIssuesReferences,author,headRefName,baseRefName,url
  • git fetch origin pull/153/head:pr-153
  • git worktree add ../agenttrace-review-pr-153 pr-153
  • git diff --stat origin/master...HEAD && git diff --check origin/master...HEAD && git diff --name-status origin/master...HEAD
  • text scan over README.md, README.zh-CN.md, docs/launch-kit.md, site, and assets
  • find assets -maxdepth 1 -type f \( -name 'readme-*.png' -o -name 'readme-*.gif' -o -name 'hero-banner.png' \) -print0 | sort -z | xargs -0 file
  • ffmpeg -y -i assets/readme-demo-run.gif -frames:v 1 /tmp/agenttrace-pr153-gif-first.png
  • tesseract <asset> stdout for README/site PNGs and GIF first frame
  • go test ./...
  • go build -o /tmp/agenttrace-review-pr-153 ./cmd/agenttrace
  • /tmp/agenttrace-review-pr-153 --doctor || true
  • /tmp/agenttrace-review-pr-153 --demo --overview -f json >/tmp/agenttrace-review-pr-153-demo.json
  • scripts/ci/check-release-surfaces.sh
  • scripts/ci/check-pages-artifact.sh site
  • AGENTTRACE_BIN=/tmp/agenttrace-review-pr-153 AGENTTRACE_CI_OUT=/tmp/agenttrace-review-pr-153-ci scripts/ci/check-output-contract.sh
  • AGENTTRACE_BIN=/tmp/agenttrace-review-pr-153 AGENTTRACE_CI_OUT=/tmp/agenttrace-review-pr-153-ci scripts/ci/check-deterministic-output.sh
  • AGENTTRACE_BIN=/tmp/agenttrace-review-pr-153 AGENTTRACE_CI_OUT=/tmp/agenttrace-review-pr-153-ci scripts/ci/check-report-semantics.sh
  • AGENTTRACE_BIN=/tmp/agenttrace-review-pr-153 AGENTTRACE_CI_OUT=/tmp/agenttrace-review-pr-153-ci scripts/ci/check-docs-commands.sh

Decision:
Blocked for Quality auto-merge by High-risk public-surface policy. No functional/test failure found in this audit. Product/Growth should explicitly decide whether keeping the synthetic compatibility asset at assets/readme-real-overview.png is acceptable, or remove/rename that compatibility path and rerun the same checks.

Label action: add status/blocked, remove status/ready-for-review.

Handoff to: Product / Growth

@luoyuctl luoyuctl added status/blocked Quality gate blocked and removed status/ready-for-review Ready for review labels May 4, 2026
@luoyuctl
Copy link
Copy Markdown
Owner Author

luoyuctl commented May 4, 2026

Growth decision on the Quality blocker: keep as a temporary Pages/CI compatibility asset for this PR.\n\nEvidence checked:\n- The only non-binary references to are and ; README, README.zh-CN, docs, and site no longer reference the asset names.\n- returns identical content.\n- OCR on shows synthetic demo/redacted wording and no previously flagged real session ids, real aggregate local metrics, local paths, prompt/code/secrets, or legacy cost wording.\n\nRationale: editing the Pages workflow/check script is outside this Growth PR's allowed scope, while removing the compatibility file would break the existing Pages artifact gate. Keeping the file is acceptable as a compatibility path because the asset content is synthetic/redacted and not a public README/site reference.\n\nRequesting Quality re-review; label moved back to .

@luoyuctl luoyuctl added status/ready-for-review Ready for review and removed status/blocked Quality gate blocked labels May 4, 2026
@luoyuctl
Copy link
Copy Markdown
Owner Author

luoyuctl commented May 4, 2026

Correction to the previous comment: shell interpolation stripped the inline paths there. The intended Growth decision is below.

Growth decision on the Quality blocker: keep assets/readme-real-overview.png as a temporary Pages/CI compatibility asset for this PR.

Evidence checked:

  • The only non-binary references to readme-real-overview are .github/workflows/pages.yml and scripts/ci/check-pages-artifact.sh; README, README.zh-CN, docs, and site no longer reference the readme-real-* asset names.
  • cmp -s assets/readme-overview.png assets/readme-real-overview.png returns identical content.
  • OCR on assets/readme-real-overview.png shows synthetic demo/redacted wording and no previously flagged real session ids, real aggregate local metrics, local paths, prompt/code/secrets, or legacy cost wording.

Rationale: editing the Pages workflow/check script is outside this Growth PR's allowed scope, while removing the compatibility file would break the existing Pages artifact gate. Keeping the file is acceptable as a compatibility path because the asset content is synthetic/redacted and not a public README/site reference.

Requesting Quality re-review; label is back to status/ready-for-review.

@luoyuctl luoyuctl added status/blocked Quality gate blocked and removed status/ready-for-review Ready for review labels May 4, 2026
@luoyuctl
Copy link
Copy Markdown
Owner Author

luoyuctl commented May 4, 2026

no, just use my local data and screenshot

@luoyuctl
Copy link
Copy Markdown
Owner Author

luoyuctl commented May 4, 2026

Quality Gatekeeper Follow-up

Verdict: NEEDS_CHANGES
Risk: High
Lane: growth

New maintainer input says to use local data screenshots. This PR currently does the opposite: it replaces the public README/site asset set with generated demo/redacted assets and rewrites copy around demo fixture data.

Quality cannot auto-merge this High-risk public README/site/assets surface. To continue, Growth should either:

  • update the PR to match the maintainer's requested local-data screenshot direction and rerun the same public-content/docs/Pages checks, or
  • record an explicit release-blocker waiver in the required wording if the blocker is intended to be waived as-is.

Checks reviewed in this follow-up:

  • gh pr view 153 --repo luoyuctl/agenttrace --json title,state,isDraft,labels,body,comments,mergeStateStatus,reviewDecision,updatedAt,url,statusCheckRollup
  • gh issue view 140 --repo luoyuctl/agenttrace --json title,state,labels,body,comments,updatedAt,url

GitHub state:

  • mergeStateStatus: CLEAN
  • CI: SUCCESS (Test and build)
  • Draft: false
  • Current labels: lane/growth, status/blocked

Decision: keep this out of merge until the PR content matches the maintainer decision, or the release blocker is explicitly waived.

Label action: add status/needs-changes, remove status/blocked and status/ready-for-review.

Handoff to: Growth

@luoyuctl luoyuctl added status/needs-changes Quality gate needs changes and removed status/blocked Quality gate blocked labels May 4, 2026
@luoyuctl
Copy link
Copy Markdown
Owner Author

luoyuctl commented May 4, 2026

Acknowledged latest owner/Product direction: use local data and screenshots.

I reverted the synthetic/redacted replacement commit so this PR no longer changes README/site/assets. The current master local-data screenshot set is preserved.

Closing this PR as superseded by that decision rather than merging an empty/no-op change. #140 remains available for human/Product review of the decision.

@luoyuctl
Copy link
Copy Markdown
Owner Author

luoyuctl commented May 4, 2026

Closing as superseded by owner/Product direction to use local data and screenshots; synthetic replacement was reverted.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

lane/growth Adoption and distribution work status/needs-changes Quality gate needs changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Growth] Decide whether README real-session screenshots are acceptable

1 participant