Skip to content

docs: add business question examples#11

Merged
kholdrex merged 1 commit into
masterfrom
docs/business-question-examples
Jun 2, 2026
Merged

docs: add business question examples#11
kholdrex merged 1 commit into
masterfrom
docs/business-question-examples

Conversation

@kholdrex

@kholdrex kholdrex commented Jun 1, 2026

Copy link
Copy Markdown
Owner

Summary

Adds a business-question examples guide for teams evaluating CodeToQuery against common B2B SaaS reporting needs. The guide pairs example prompts with narrow table allowlists and the safety checks reviewers should perform before running generated queries.

Changes

  • Adds docs/business-question-examples.md with revenue, product usage, and customer operations examples.
  • Documents a safe preview-before-execution pattern using Query#preview and query.safe?.
  • Links the examples guide from the README introduction.

Test Plan

  • Documentation smoke checks passed for README link presence, preview guidance, and sensitive logging warnings.
  • Diff whitespace checks passed.
  • Independent docs/security review found no blocking findings after API-shape claims were verified against the implementation.

@kholdrex kholdrex merged commit 873ce8b into master Jun 2, 2026
34 checks passed
@kholdrex kholdrex deleted the docs/business-question-examples branch June 2, 2026 02: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.

1 participant