Skip to content

[Growth] Surface report regression evidence in public docs#228

Merged
luoyuctl merged 1 commit into
masterfrom
growth/206-report-evidence-docs
May 19, 2026
Merged

[Growth] Surface report regression evidence in public docs#228
luoyuctl merged 1 commit into
masterfrom
growth/206-report-evidence-docs

Conversation

@luoyuctl

Copy link
Copy Markdown
Owner

Closes #206

Summary

  • add README and README.zh-CN wording for local baseline comparison, incident timelines, and conservative tool authority report evidence
  • add a copyable baseline-then-compare workflow to the common commands
  • update site metadata and report/gate copy so the public page explains the report evidence model without hosted-service or enforcement claims

User-facing value

First-time evaluators can now see that reports explain regressions with local baseline deltas, incident timeline evidence, and tool authority categories instead of only generic health or slow-run summaries.

Adoption rationale

This makes the post-v0.4.6 report model legible on the main public docs while keeping the positioning local-first and evidence-oriented.

Scope

  • README.md
  • README.zh-CN.md
  • site/index.html

No Go source, release, tag, package publish, npm, Homebrew, or external posting work.

Test plan

  • git diff --check
  • go test ./...
  • go build -o /tmp/agenttrace-growth-check ./cmd/agenttrace
  • /tmp/agenttrace-growth-check --doctor
  • scripts/ci/check-release-surfaces.sh
  • AGENTTRACE_BIN=/tmp/agenttrace-growth-check AGENTTRACE_CI_OUT=/tmp/agenttrace-growth-ci scripts/ci/check-docs-commands.sh
  • scripts/ci/check-pages-artifact.sh site
  • AGENTTRACE_BIN=/tmp/agenttrace-growth-check AGENTTRACE_CI_OUT=/tmp/agenttrace-growth-ci scripts/ci/check-output-contract.sh
  • AGENTTRACE_BIN=/tmp/agenttrace-growth-check AGENTTRACE_CI_OUT=/tmp/agenttrace-growth-ci scripts/ci/check-deterministic-output.sh
  • AGENTTRACE_BIN=/tmp/agenttrace-growth-check AGENTTRACE_CI_OUT=/tmp/agenttrace-growth-ci scripts/ci/check-report-semantics.sh
  • markdownlint README.md docs/**/*.md (not available in this environment: command not found)

Safety checklist

  • Public copy avoids internal growth targets and attention-seeking language
  • No hosted tracing, uploaded-log, security-enforcement, release, or package-publish claim added
  • No npm package/prepared-wrapper surface restored
  • README/site proof-point lists unchanged

@luoyuctl luoyuctl added lane/growth Adoption and distribution work status/ready-for-review Ready for review labels May 19, 2026
@luoyuctl

Copy link
Copy Markdown
Owner Author

Event: Validation
Actor: Product
Scope: PR #228 / Issue #206 public report evidence docs
State change: no PR label change; PR already has lane/growth + status/ready-for-review
Evidence: Reviewed head 49f71fe. GitHub CI Test and build is SUCCESS and mergeStateStatus=CLEAN. Local Product validation passed git diff --check, go build, go test ./..., scripts/ci/check-release-surfaces.sh, scripts/ci/check-pages-artifact.sh site, docs command smoke, output contract, deterministic output, report semantics, and demo JSON generation. Demo JSON still exposes version 0.4.6, 3 incident timelines, and authority categories read_only_files / test_or_build.

Product acceptance check:

  • scope is limited to README.md, README.zh-CN.md, and site/index.html
  • public copy describes baseline comparison when supplied, incident timelines, and conservative tool authority categories as local report evidence
  • no hosted tracing, uploaded-log, security-enforcement, release availability, package-publish, npm package/prepared-wrapper, Homebrew publish, external posting, or internal platform target claim was added
  • README/site proof-point lists were not changed
  • release-surface guard remains green
    Next owner: Quality / Growth

Decision: Product validation passes for the #206 acceptance boundary. This is ready for normal review/merge handling; Product is not merging it.

@luoyuctl

Copy link
Copy Markdown
Owner Author

Quality Gatekeeper Review

Verdict: PASS
Risk: Medium
Lane: growth
Checks:

  • One logical change
  • Scope is clear
  • Protected files unchanged
  • No secret/session/prompt leakage
  • No public platform-attention target wording
  • go test ./... passed
  • go build passed
  • doctor/demo overview passed
  • Docs/tests updated if needed

Notes:

  • GitHub state: mergeStateStatus=CLEAN, non-draft, head 49f71fed341fc758b584edbbdb203fcc9adeb1c8, CI Test and build SUCCESS.
  • Changed files: README.md, README.zh-CN.md, site/index.html (+26/-8). Scope matches Surface report regression evidence in public docs #206 public-doc report evidence packaging.
  • The new copy stays local-first and evidence-oriented: local baseline comparison when supplied, incident timelines, conservative tool authority categories, and terminal/report evidence. I did not find hosted tracing, uploaded-log, security-enforcement, release/package availability, volatile exact live-run aggregate, or npm package/prepared-wrapper claims.
  • Existing Homebrew badge and “No hosted backend / No prompt upload” wording are pre-existing local-first/release-surface text, not new package or hosted-service claims.

Validation commands:

  • git diff --check origin/master...HEAD
  • git diff --name-status origin/master...HEAD
  • go test ./...
  • go build -o /tmp/agenttrace-review-pr-228 ./cmd/agenttrace
  • /tmp/agenttrace-review-pr-228 --doctor || true
  • /tmp/agenttrace-review-pr-228 --demo --overview -f json
  • scripts/ci/check-release-surfaces.sh
  • AGENTTRACE_BIN=/tmp/agenttrace-review-pr-228 AGENTTRACE_CI_OUT=/tmp/agenttrace-review-pr-228-ci scripts/ci/check-docs-commands.sh
  • scripts/ci/check-pages-artifact.sh site
  • AGENTTRACE_BIN=/tmp/agenttrace-review-pr-228 AGENTTRACE_CI_OUT=/tmp/agenttrace-review-pr-228-ci scripts/ci/check-output-contract.sh
  • AGENTTRACE_BIN=/tmp/agenttrace-review-pr-228 AGENTTRACE_CI_OUT=/tmp/agenttrace-review-pr-228-ci scripts/ci/check-deterministic-output.sh
  • AGENTTRACE_BIN=/tmp/agenttrace-review-pr-228 AGENTTRACE_CI_OUT=/tmp/agenttrace-review-pr-228-ci scripts/ci/check-report-semantics.sh
  • rg -n "hosted|upload|uploaded|telemetry|security enforcement|enforce|certif|npm|package publish|Homebrew|GitHub Release|1000|star|stars|viral|popularity|attention|cloud|SaaS|server" README.md README.zh-CN.md site/index.html
  • rg -n "baseline comparison|baseline|incident timeline|incident timelines|tool authority|authority categories|authority evidence|local baseline|回归|baseline|incident timeline|tool authority" README.md README.zh-CN.md site/index.html

Decision: PASS. This can be squash-merged under the automatic merge rules.

@luoyuctl luoyuctl merged commit 4d7786a into master May 19, 2026
1 check passed
@luoyuctl luoyuctl deleted the growth/206-report-evidence-docs branch May 19, 2026 17:43
@luoyuctl

Copy link
Copy Markdown
Owner Author

Quality Gatekeeper Review

Verdict: PASS
Risk: Medium
Lane: growth
Checks:

  • One logical change
  • Scope is clear
  • Protected files unchanged under the current Surface report regression evidence in public docs #206 public-doc cleanup exception
  • No secret/session/prompt leakage
  • No public platform-attention target wording
  • GitHub mergeStateStatus=CLEAN; mergeable=MERGEABLE
  • GitHub CI Test and build passed
  • go test ./... passed
  • go build passed
  • doctor/demo overview passed
  • Docs/release/output/Page checks passed
  • Docs/tests updated if needed

Validation commands run on temporary review worktree agenttrace-review-pr-228 at 49f71fed341fc758b584edbbdb203fcc9adeb1c8:

  • git diff --check origin/master...HEAD
  • test -z "$(gofmt -l .)"
  • go test ./...
  • go build -o /tmp/agenttrace-review-pr-228 ./cmd/agenttrace
  • go vet ./...
  • bash -n scripts/record-demo.sh scripts/ci/*.sh
  • ruby -c homebrew/Formula/agenttrace.rb
  • /tmp/agenttrace-review-pr-228 --doctor || true
  • /tmp/agenttrace-review-pr-228 --demo --overview -f json
  • scripts/ci/check-release-surfaces.sh
  • scripts/ci/check-pages-artifact.sh site
  • AGENTTRACE_BIN=/tmp/agenttrace-review-pr-228 AGENTTRACE_CI_OUT=/tmp/agenttrace-review-pr-228-ci scripts/ci/check-docs-commands.sh
  • AGENTTRACE_BIN=/tmp/agenttrace-review-pr-228 AGENTTRACE_CI_OUT=/tmp/agenttrace-review-pr-228-ci scripts/ci/check-output-contract.sh
  • AGENTTRACE_BIN=/tmp/agenttrace-review-pr-228 AGENTTRACE_CI_OUT=/tmp/agenttrace-review-pr-228-ci scripts/ci/check-deterministic-output.sh
  • AGENTTRACE_BIN=/tmp/agenttrace-review-pr-228 AGENTTRACE_CI_OUT=/tmp/agenttrace-review-pr-228-ci scripts/ci/check-report-semantics.sh

Notes: The PR is limited to README.md, README.zh-CN.md, and site/index.html. The public copy describes implemented local report evidence only: baseline comparison when supplied, incident timelines, conservative tool authority categories, and report evidence surfaces. I did not find new hosted tracing, uploaded-log, security-enforcement, package/release availability, npm surface, external posting, public proof-point expansion, or volatile exact live-run aggregate claims.
Decision: PASS and eligible for auto-merge.

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/auto-merged

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Surface report regression evidence in public docs

1 participant