docs: lead with explorable prototype workflows - #2283
Open
pmcelhaney wants to merge 2 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Repositions the README’s introduction to emphasize Counterfact as a tool for building explorable prototype workflows (stateful, retryable, error-path-aware) before a backend is available, and updates the “Start with the workflow you need” table to match that framing.
Changes:
- Updates the primary README tagline and opening paragraphs to lead with “explorable prototype” workflows for frontend development.
- Adds guidance on when simpler fixtures are sufficient vs. when Counterfact is the better fit.
- Rewrites the workflow table entries to prioritize prototype exploration and UI-independent debugging use cases.
|  [](https://coveralls.io/github/counterfact/api-simulator)   [](https://deepwiki.com/counterfact/api-simulator) | ||
|
|
||
| ## Turn an OpenAPI document into an editable, stateful local API. | ||
| ## Build an explorable prototype before your backend exists. |
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
Suppressed comments (1)
README.md:7
- The top-level heading ends with a period, which is inconsistent with the rest of the README section headings (they omit trailing punctuation) and can look odd in TOCs/anchor previews.
## Prototype your UI before investing in backend development.
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.
No description provided.