docs: fix CLI reference, programmatic API example, and without-openapi syntax errors#1964
Merged
pmcelhaney merged 2 commits intomainfrom Apr 27, 2026
Merged
docs: fix CLI reference, programmatic API example, and without-openapi syntax errors#1964pmcelhaney merged 2 commits intomainfrom
pmcelhaney merged 2 commits intomainfrom
Conversation
Closed
Copilot
AI
changed the title
[WIP] Review documentation for inconsistencies and missing details
docs: fix CLI reference, programmatic API example, and without-openapi syntax errors
Apr 27, 2026
pmcelhaney
approved these changes
Apr 27, 2026
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
Several documentation pages had stale, incorrect, or broken content: the CLI reference was missing flags, the FAQ showed a wrong API signature, and the without-OpenAPI guide had invalid JS syntax and a broken link.
Original Prompt
Review the docs. Update any inconsistencies or errors and add missing details.
Manual acceptance tests
docs/reference.mdCLI table lists all flags fromnpx counterfact@latest --helpincluding-p,--prune,--no-admin-api,--admin-api-token,--no-update-check, and--configdocs/faq.mdprogrammatic API example uses theConfig-object signature matchingdocs/features/programmatic-api.mddocs/features/without-openapi.md"reference guide" link resolves and the JS examples use validexport functionsyntaxdocs/features/programmatic-api.md"Return value" heading and table render as separate elementsTasks
docs/reference.md: Added missing CLI flags (-pfor--port;--no-admin-api,--admin-api-token,--prune,--no-update-check,--config); fixed descriptions for--generateand--watchto match actual help text; used—instead offalsefor boolean-negation flagsdocs/faq.md: Replaced incorrectcounterfact("openapi.yaml", "api", { port, serve })call with the correctcounterfact(config: Config)formdocs/features/without-openapi.md: Fixedexport const GET() {→export function GET()(invalid syntax); fixed[usage guide](./usage.md)→[reference guide](../reference.md)(file didn't exist at that path); removed duplicate "so that so that"docs/features/programmatic-api.md: Added missing blank line between the## Return valueheading and the Markdown table