Skip to content

docs: fix CLI reference, programmatic API example, and without-openapi syntax errors#1964

Merged
pmcelhaney merged 2 commits intomainfrom
copilot/review-docs-update
Apr 27, 2026
Merged

docs: fix CLI reference, programmatic API example, and without-openapi syntax errors#1964
pmcelhaney merged 2 commits intomainfrom
copilot/review-docs-update

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 27, 2026

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.md CLI table lists all flags from npx counterfact@latest --help including -p, --prune, --no-admin-api, --admin-api-token, --no-update-check, and --config
  • docs/faq.md programmatic API example uses the Config-object signature matching docs/features/programmatic-api.md
  • docs/features/without-openapi.md "reference guide" link resolves and the JS examples use valid export function syntax
  • docs/features/programmatic-api.md "Return value" heading and table render as separate elements

Tasks

  • docs/reference.md: Added missing CLI flags (-p for --port; --no-admin-api, --admin-api-token, --prune, --no-update-check, --config); fixed descriptions for --generate and --watch to match actual help text; used instead of false for boolean-negation flags
  • docs/faq.md: Replaced incorrect counterfact("openapi.yaml", "api", { port, serve }) call with the correct counterfact(config: Config) form
  • docs/features/without-openapi.md: Fixed export 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 value heading and the Markdown table

Copilot AI linked an issue Apr 27, 2026 that may be closed by this pull request
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
Copilot AI requested a review from pmcelhaney April 27, 2026 23:12
@pmcelhaney pmcelhaney marked this pull request as ready for review April 27, 2026 23:14
@pmcelhaney pmcelhaney enabled auto-merge April 27, 2026 23:14
@pmcelhaney pmcelhaney added this pull request to the merge queue Apr 27, 2026
Merged via the queue into main with commit e2dff75 Apr 27, 2026
7 of 10 checks passed
@pmcelhaney pmcelhaney deleted the copilot/review-docs-update branch April 27, 2026 23:20
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.

Docs review

2 participants