docs: lead with UI-first prototyping - #2315
Draft
pmcelhaney wants to merge 1 commit into
Draft
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates Counterfact’s top-level and package-level documentation to lead with a UI-first prototyping message, and adds a patch changeset so the updated README content is published to npm.
Changes:
- Update the root repository landing page headline and intro copy to emphasize UI-first prototyping.
- Expand
packages/counterfact/README.mdwith the full UI-first narrative and an updated “Start with the workflow you need” table. - Add a patch changeset for
counterfactto publish the README update.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| README.md | Updates the repository landing headline and intro copy to lead with UI-first prototyping. |
| packages/counterfact/README.md | Ports the longer UI-first narrative and updates the workflow table for the published package README. |
| .changeset/bright-uis-lead.md | Adds a patch changeset to ship the documentation update to npm. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| <h1><img src="./counterfact.svg" alt="Counterfact" border="0"></h1> | ||
|
|
||
| ## Turn an OpenAPI document into an editable, stateful local API. | ||
| ## Prototype your UI before investing in backend development |
| | Prototype a UI before backend investment | Create data, revisit it later, and deliberately show errors or alternate outcomes | [Build a stateful flow](./docs/first-10-minutes.md#build-a-stateful-flow) | | ||
| | Build or debug a UI independently | Use a controlled API world while the real backend is absent, unavailable, or broken | [Build a stateful flow](./docs/first-10-minutes.md#build-a-stateful-flow) | | ||
| | Make failures repeatable | Reset, fail, recover, and tear down the same way every run | [Automate a deterministic test](./docs/first-10-minutes.md#automate-a-deterministic-test) | | ||
| | Give a coding agent a reliable sandbox | Leave a resettable context and an HTTP test for review | [Give an agent a verifiable task](./docs/first-10-minutes.md#give-an-agent-a-verifiable-task) | |
|  [](https://coveralls.io/github/counterfact/api-simulator)   [](https://deepwiki.com/counterfact/api-simulator) | ||
|
|
||
| ## Turn an OpenAPI document into an editable, stateful local API. | ||
| ## Prototype your UI before investing in backend development |
14 tasks
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
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.
Summary
counterfactpackage READMESupersedes the monorepo-incompatible implementation in #2283.
Original Prompt
All open PRs are going to be outdated after the monorepo changes. Review each PR and devise a high level plan to achieve what the PR intends under the new structure.
Proceed. Do each one sequentially using subagents.
Manual acceptance tests
counterfactREADME and verify the fuller UI-first workflow explanation is present.Tasks
packages/counterfact/README.md.counterfactpatch changeset.git diff --check.Repository learning check