docs: make Method Factory README reader-first - #4
Merged
Conversation
README Audience-UX revision (docs-only). Rewrites README.md with a reader-first information architecture modeled on the Process Engine README's reader experience (not its wording): - outcome-oriented hero answering 'what does this do for me' before any storage/implementation detail; - plain-language 'What it does' with the human journey alongside the pipeline diagram; - 'Why Method Factory?' explaining the code-enforces / model-creates / human-gates insight without requiring Action Envelope knowledge; - 'What makes it different' in benefit terms; - 'Who this is for' (good fit / not a fit) with transparent RC limitations; - 'What using Method Factory feels like' - a concrete Etsy-store example walkthrough; - 'What RC1 provides today' - explicit distinction between the product architecture and the packaged public surface (migrate-store + export only; lifecycle not exposed; no import/backup/restore/GC); - engineering detail (validation, architecture, hash-chain non-claim) moved downward and condensed; - Process Engine presented as lineage, not dependency. Only README.md changed. Product code, tests, CI, package version (2.0.0rc1), ADRs, and release objects untouched.
README-only follow-up on docs/readme-audience-ux (PR #4): 1. Fix broken Process Engine case-study link: evals/case-study-first-run.md (404) -> case-study/case-study-first-run.md (canonical live path, verified 200 via GitHub API). External GitHub file links now verified, not just internal paths. 2. Surface the RC1 usability boundary near the top: concise callout after the plain-language opening notes the deterministic foundation is real, v2.0.0-rc.1 is an engineering RC, the packaged public interface exposes migrate-store/export, and the full conversational authoring lifecycle is not yet a polished public entry point. No duplication of the full 'What RC1 provides today' section. 3. Improve Getting Started installation UX: explicit download-from-GitHub- Release step before pip install of the local wheel; editable install clearly marked as the development/contributor path, not equivalent to public release installation. No PyPI instructions (RC1 is not on PyPI). Release artifact boundary respected: v2.0.0-rc.1 tag/release/wheel untouched; no wheel rebuilt or asset replaced; no claim that a wheel from this docs branch is the released artifact. README.md only; product code/tests/CI/package version unchanged.
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.
Docs-only: reader-first README for Method Factory
README Audience-UX revision. README.md only - no product code, tests, CI, package version (
2.0.0rc1), ADRs, or release objects changed.What changed
Rewrote
README.mdwith a reader-first information architecture, using the Process Engine README as a reader-experience reference (not copied wording):mf migrate-store+mf exportonly; lifecycle/import/backup/restore/GC not exposed).Base:
380b8e376e0b1ecac1443ef2c9ee104268236a70(currentmain). Release identityv2.0.0-rc.1untouched.