Skip to content

Redesign README for Agent-first onboarding - #29

Open
houlianpi wants to merge 7 commits into
mainfrom
docs/readme-agent-onboarding-28
Open

houlianpi wants to merge 7 commits into
mainfrom
docs/readme-agent-onboarding-28

Conversation

@houlianpi

@houlianpi houlianpi commented Oct 29, 2026 •

Copy link
Copy Markdown

Requirement

Closes #28

User-visible result

The root README now presents AutoGenesis from the development and QA user's perspective:

Write the behavior. Watch AI record it. Replay without AI.

It follows the evidence-first landing-page pattern used by FSQ: centered product positioning, status badges, a complete-test media position, a scenario-to-execution-to-result story, scoped Edge deployment evidence, then Quick Start. It explains the full AutoGenesis loop—BDD scenario, real application execution through MCP, observed-call recording, generated-code review, and replay without the Coding Agent—before installation or package mechanics. The visual-model exception, team workflow, four target platforms, and Agent-first path remain explicit.

Scope

  • Replace the root README information architecture and stale template content.
  • Lead with the BDD-to-recording-to-replay outcome.
  • Explain the developer, QA, and CI collaboration model.
  • Make Agent-first onboarding primary and demote CLI/Runtime internals.
  • Follow FSQ's product-first hierarchy while preserving AutoGenesis terminology and contracts.
  • Add an original responsive AutoGenesis logo for light and dark GitHub themes.
  • Present four approved Microsoft Edge product-line results in high-impact responsive desktop/mobile artwork without generalizing them into universal benchmarks.
  • Reserve invisible slots for approved demo, execution, and replay media instead of fabricating assets.
  • Embed the canonical generated Agent Install Prompt in a collapsed reference.
  • Require approval before bootstrap process/network/write activity.
  • Bind installed and discovered Setup Skill identity to the approved path, digest, and Contract version.
  • Keep unpublished public package commands fail-closed while documenting the post-publication interface.
  • Add contract tests for the strengthened generated prompt.

Non-goals

  • Complete-test video, scenario card, execution capture, and replay evidence remain intentionally blank until approved source media is supplied.
  • The official Microsoft Edge product icon is not bundled without confirmed trademark authorization; the panel uses an original browser/deployment glyph and truthful product text.
  • No Runtime, Skill body, CLI behavior, package, workflow, schema, or release changes.
  • No public package or Skill publication.
  • No claim that native Windows or the four Coding Agents completed final acceptance.

Interface changes

The repository landing page is now the product and onboarding interface. The generated agent-install-prompt.txt additionally requires exact-plan approval, conflict/shadow detection, installed-byte verification, discovery-path identity, and fresh approval after plan changes. Runtime and package entrypoints are unchanged.

Acceptance scenarios

Given a developer or QA engineer opens the repository
When they read the README from the top
Then they understand that BDD drives a real application recording
And approved generated tests replay without the Coding Agent
And model-backed visual assertions are identified as the explicit model-dependent exception

Given a reader evaluates evidence that the approach operates at scale
When they read the Edge browser product-line results
Then they see 2.30M steps in the reported 30-day period and 3,193 monthly hours saved
And they see four platforms and 99.7% pass-rate consistency
And the README does not present those figures as universal benchmarks

Given a user has a supported native host, Python 3.10+, and one targeted Coding Agent
When the user follows the Agent-first path
Then the agent verifies and installs only the canonical Setup Skill after explicit approval
And proves the discovered Skill resolves to the approved destination and identity

Given the public packages are not yet published
When a reader reaches installation
Then the README prohibits resolving or executing the unpublished coordinate
And documents the exact pinned post-publication interface without a runnable shell block

Verification evidence

Check Result Evidence
Targeted tests Pass agent-contract/tests/test_skills.py: 18 passed
Latest CI Pending Latest commit matrix is running; earlier revision passed all 17 checks
Render smoke test Pass Published branch rendered on GitHub, including Mermaid; all four badges loaded and every repository-relative link resolves
Edge proof render Pass Published GitHub README selects an 1120×480 desktop panel at 838×359 and a dedicated 720×950 mobile panel at 324×428, with no overflow or broken images
Edge proof review Pass Independent EdgeImpactPanelReview — APPROVE after the mobile composition was stacked for readable labels
Edge metric review Pass Independent EdgeMetricsReadmeReview — APPROVE against the supplied source and Human Product Owner correction
Logo render Pass Responsive light/dark SVGs rendered on GitHub with correct source selection, alt text, and no broken image
Logo review Pass Independent AutoGenesisLogoReview — APPROVE; legible at desktop, mobile, and 260 px widths
Generated prompt identity Pass Canonical generated prompt matches the collapsed README block byte-for-byte
Product review Pass Independent FSQReadmeProductReview — APPROVE
Security review Pass Independent FSQReadmeSecurityReview — APPROVE; canonical prompt and safety contracts unchanged
Prompt eval Pass Four fixed canaries: baseline 3/4, candidate 4/4, regressions 0

Agent roles

  • Implementer: Main session
  • Reviewers: Independent FSQReadmeProductReview, AutoGenesisLogoReview, EdgeMetricsReadmeReview, and EdgeImpactPanelReview sessions — APPROVE
  • Acceptor: Human Product Owner, through README review and subsequent OMP/Codex CLI/Pi/Copilot CLI testing
  • Security reviewer: Independent FSQReadmeSecurityReview session — APPROVE

Security review

  • Secrets and sensitive inputs are not written to logs, generated code, or tracked configuration.
  • File writes are scoped and atomic.
  • Command/process inputs are not shell-interpolated.
  • Package downloads and remote instructions are pinned or verified.
  • Not security-sensitive; explanation:

The README requires callers to keep arbitrary plaintext credentials out of Feature/task text and explains that AutoGenesis cannot detect arbitrary embedded credentials. The copyable prompt fails closed on unsupported hosts, unapproved activity, digest mismatch, conflicting content, discovery shadowing, transformed installed bytes, or unverifiable Skill resolution. Preview language is limited to the bindings actually enforced: session, payload, destination, and destination base state.

Compatibility impact

No Runtime behavior changes. Coding Agents that cannot prove resolved Skill path/digest/version stop instead of claiming installation success. Replay is accurately described as independent of the Coding Agent; explicitly model-backed visual assertions retain their configured model dependency.

Rollback

Revert this pull request. No user data, package state, Runtime state, or schema migration is involved.

Known limitations

  • Complete-test video, scenario card, execution capture, and replay evidence are not yet available; their README slots remain invisible and empty.
  • Public AutoGenesis 1.1 packages and immutable Skill assets are not yet published; public installation remains gated.
  • Native Windows post-publication acceptance is pending.
  • OMP, Codex CLI, Pi, and GitHub Copilot CLI acceptance is pending.

Definition of Done

  • The issue met Definition of Ready before implementation began.
  • Scope and non-goals were preserved or changed by explicit Human Product Owner direction.
  • All acceptance scenarios pass in a clean environment.
  • Required CI checks pass for the latest commit.
  • An independent reviewer approved the change.
  • An independent acceptor posted final evidence.
  • Security review passed.
  • Prompt changes include an eval comparison.
  • Documentation and machine-readable configuration agree.

@houlianpi

Copy link
Copy Markdown
Author

README redesign evidence for commit ce18d59 / PR #29

Independent code review: APPROVE.

  • Confirmed package names, versions, entrypoints, Skill role split, readiness conditions, status disclosures, links, and exact gated CLI sequence.
  • Initial findings for Windows status, bootstrap approval, and physical-iPhone readiness were remediated and re-reviewed.

Independent security review: APPROVE.

  • Agent Install Prompt now requires exact-plan approval before process execution, network access, or filesystem writes, with fresh approval after any change.
  • It preserves conflicting existing content and fails closed on shadowing, ambiguity, transformed bytes, digest/Contract mismatch, or inability to prove the discovered path and identity.
  • The unpublished public package coordinate is explicitly prohibited; exact future CLI commands remain inline documentation, not a runnable shell block.

Prompt eval comparison

  • Harness: same session slow model for baseline and candidate; independent structured grading.
  • Fixed cases: approval before fetch, conflicting shadow Skill, changed plan, and unprovable discovery resolution.
  • Baseline (c7ff16e): 3/4.
  • Candidate (ce18d59): 4/4.
  • Regressions: 0.
  • Candidate improvement: an agent unable to prove the resolved Skill path/digest/version stops instead of reporting installation success.
  • Raw local evidence: /tmp/autogenesis-readme-prompt-eval.json (synthetic paths only; no credentials).

Verification

  • Agent Contract Skill/release tests: 18 passed.
  • Generated Agent Install Prompt matches the README block byte-for-byte.
  • GitHub GFM render completed successfully.
  • All 11 repository-relative links resolve.
  • autogenesis --help and autogenesis install --help matched the documented interface in an isolated verifier environment.
  • git diff --check passed.

Human Product Owner acceptance remains pending through OMP, Codex CLI, Pi, and GitHub Copilot CLI. Public package/release publication and native Windows acceptance remain gated.

@houlianpi

Copy link
Copy Markdown
Author

README product redesign update — commit b66da16

The first candidate was rejected by the Human Product Owner. The revised README now leads with the approved product position:

Write the behavior. Watch AI record it. Replay without AI.

Observable changes:

  • Leads with BDD → exact real-app execution → observed MCP recording → preview approval → Behave replay.
  • Explains the development/QA/CI collaboration model before installation.
  • Makes Agent-first onboarding primary; CLI, package, Runtime, and trust mechanics are lower-level content.
  • Covers Windows, macOS, iOS, and Android without presenting pending acceptance as complete.
  • Removes the stale repository template and does not route onboarding through the old clone-based documentation site.
  • Keeps the full verified Agent Install Prompt in a collapsed reference.
  • Explicitly qualifies model-backed visual assertions: replay does not require the Coding Agent, while recorded visual-model checks retain their configured model dependency.
  • Describes actual preview bindings and arbitrary-secret detection limitations without overstating protection.
  • A real Hero Demo remains intentionally deferred by Product Owner decision; no fake placeholder was added.

Independent review:

  • Product/correctness review ReadmeProductReviewV2: APPROVE.
  • Security review ReadmeSecurityReviewV2: APPROVE.

Verification:

  • GitHub GFM and Mermaid rendering succeeded.
  • Every repository-relative link resolves.
  • The collapsed Agent Install Prompt matches generated release output byte-for-byte.
  • git diff --check passed.

PR: #29

@houlianpi

Copy link
Copy Markdown
Author

FSQ-style README refinement — commit 7860e26

Human Product Owner direction: learn from https://github.com/FSQ-lab/FSQ and leave unavailable media blank until approved assets arrive.

Changes:

  • Adopted FSQ's product-first hierarchy: centered position, badges and navigation, complete-test position, evidence sequence, then Quick Start.
  • Moved Agent-first setup immediately after product proof.
  • Added user-facing "Go further" and contribution sections.
  • Reserved invisible blank slots for the approved logo, complete-test video, scenario card, execution capture, and replay evidence. No broken links, invented screenshots, or fake placeholders were added.
  • Preserved AutoGenesis-specific BDD, preview approval, replay/model exception, pre-release, unsupported-host, credential, and trust-boundary contracts.

Verification:

  • Published branch rendered on GitHub; Mermaid rendered and all four badges loaded.
  • Every repository-relative link resolves.
  • Canonical Agent Install Prompt still matches generated release output byte-for-byte.
  • git diff --check passed.
  • Independent product review: FSQReadmeProductReview — APPROVE.
  • Independent security review: FSQReadmeSecurityReview — APPROVE.

PR: #29

@houlianpi

Copy link
Copy Markdown
Author

AutoGenesis brand logo — commit 07e66a6

Added original responsive light/dark SVG wordmarks and installed them in the README using <picture> color-scheme selection.

Concept:

  • Three nodes represent readable BDD behavior steps.
  • Their paths converge into the generated executable test.
  • The surrounding arrow represents approved replay and the regression loop.
  • Typography, loop silhouette, and neutral palette relate the mark to the FSQ family without copying FSQ's shield/check symbol.

Verification:

  • Both SVGs parse as standalone 520×120 assets.
  • No scripts, external images, links, or embedded raster data.
  • Published GitHub README selected the dark variant correctly; image loaded with 420×96.9 rendered bounds and useful alt text.
  • Independent design review AutoGenesisLogoReview: APPROVE; desktop/mobile/260 px legibility and contrast checked.

Remaining media intentionally blank: complete-test video, Scenario editorial card, execution capture, and preview/replay evidence.

@houlianpi

Copy link
Copy Markdown
Author

Scoped Edge deployment evidence — commit ba850ef

Human Product Owner confirmed the authoritative public figures and scope. README now presents only:

  • 2.30M test steps executed in the reported 30-day period.
  • 3,193 hours saved in the monthly operating period.
  • 4 platforms: Windows, macOS, iOS, and Android.
  • 99.7% pass-rate consistency.

The section explicitly attributes these to application of the approach on the Microsoft Edge browser product line and states that they are observed deployment results, not projected savings or a universal benchmark. Conflicting draft figures and all other internal PDF claims were excluded.

Verification:

  • Published GitHub README renders the four-column table and Edge results navigation anchor correctly.
  • Search confirmed no excluded 1.70M / 2,342 / 107 issues / 700+ / 413 PR / pipeline / flakiness claims.
  • git diff --check passed.
  • Independent EdgeMetricsReadmeReview: APPROVE against the supplied PDF and Human Product Owner correction.

PR: #29

@houlianpi

Copy link
Copy Markdown
Author

Edge deployment proof redesign — commit 58eabb4

Replaced the plain metric table with a high-impact production-scale panel:

  • 2.30M and 3,193 are the dominant first-tier results.
  • 4 platforms and 99.7% consistency form a supporting second tier.
  • Blue/violet/green accents tie the Edge deployment proof to the AutoGenesis visual system.
  • An original browser/deployment glyph establishes context without copying the trademarked Microsoft Edge product icon.
  • README retains truthful Microsoft Edge text and the Microsoft trademark notice.

Responsive delivery:

  • Desktop asset: 1120×480; GitHub rendered at 838×359.
  • Mobile asset: dedicated stacked 720×950 composition selected below 480 px; GitHub rendered at 324×428 with no overflow.
  • Both variants contain no scripts, external resources, links, raster data, or event handlers.
  • Complete metric prose and descriptive alt text remain outside/alongside the graphic.

Independent EdgeImpactPanelReview: initial mobile microcopy blocker fixed; final verdict APPROVE.

PR: #29

@houlianpi

Copy link
Copy Markdown
Author

Edge proof glyph visibility fix — commit 3e21a10

The browser/deployment glyph is the top-left mark inside the Edge results panel, immediately before “PROVEN AT PRODUCTION SCALE.” It was too subtle at the original 64/72 px source sizes.

Updated source sizes:

  • Desktop: 96 px, rendered at approximately 72 px in the GitHub README.
  • Mobile: 104 px, rendered at approximately 47 px.

Stroke weight, contrast, and header clear space were increased. Published GitHub desktop rendering loads the updated asset at 838×359. Independent EdgeImpactPanelReview: APPROVE; glyph is now immediately perceptible with no clipping or confusion with the official Edge swirl.

This branch has not been deployed

No deployments
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.

[Documentation]: Redesign README for Agent-first AutoGenesis 1.1 onboarding

1 participant