Address PR #183 review feedback: Copilot prompt refinements and docs #195

Summary

Follow-up work from review feedback on #183 (feat: add JSON schemas and Copilot prompts for filter/override configuration). The PR was merged/advanced, but several reviewer comments call for refinements to the Copilot prompt templates and related docs. This issue tracks addressing them.

Items to address

Documentation

• Link to prompt files for users who didn't run apiops init — In docs/guides/environment-overrides.md (~line 28), now that the prompt files are separated, link to them so users who didn't start with apiops init know where to find the prompt to use.
  • #183 (comment)

Prompt formatting

• Remove artificial word wrapping in src/templates/copilot/configure-filter-prompt.md (~line 23) — reformat more naturally and let the containing editor handle wrapping.
  • #183 (comment)
• Remove artificial word wrapping in src/templates/copilot/configure-overrides-prompt.md (~line 23) — same as above; let the editor handle word wrap.
  • #183 (comment)

Prompt behavior / UX

• Validate user-provided input in src/templates/copilot/configure-overrides-prompt.md (~line 143) — consider validating what the user tells us, only if the gh CLI is available.
  • #183 (comment)
• Auto-query instead of asking the user in src/templates/copilot/configure-overrides-prompt.md (~line 141) — rather than asking the user, check whether the gh CLI is installed, logged in, and connected to the repo, and if so query for the value automatically (asking the user for permission to check automatically first).
  • #183 (comment)
• Reduce questions by inspecting the pipeline in src/templates/copilot/configure-overrides-prompt.md (~line 159) — instead of asking the user for many things, have Copilot look at the pipeline.
  • #183 (comment)
• Confirm YAML matches the schema in src/templates/copilot/configure-overrides-prompt.md (~line 276) — have Copilot confirm the generated YAML file contents match the schema.
  • #183 (comment)
• Reconsider the show step in src/templates/copilot/configure-overrides-prompt.md (~line 279) — "show" is hard since the user could be in the VS Code terminal, GitHub Copilot, the GitHub agent tab, or elsewhere. Investigate what Copilot does here; if the instruction is sufficient, keep it. Otherwise consider an alternative, e.g. instructing the user to review the files for correctness before checking them in, and ending the prompt there.
  • #183 (comment)

Prompt naming

• Prefix prompt names with apiops in src/templates/copilot/configure-overrides-prompt.md (and the other prompts) — consider prefacing all prompt names with apiops to match the CLI and make them easier to find, e.g. /apiops-configure-overrides.
  • #183 (comment)

Related

• Follow-up to feat: add JSON schemas and Copilot prompts for filter/override configuration #183