Skip to content

[WIP] Update documentation to use task names instead of free-text#134

Merged
alexec merged 2 commits into
mainfrom
copilot/update-documentation-examples
Dec 2, 2025
Merged

[WIP] Update documentation to use task names instead of free-text#134
alexec merged 2 commits into
mainfrom
copilot/update-documentation-examples

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Dec 2, 2025

  • Understand the issue: docs use task names like fix-bug instead of slash commands /fix-bug or free-text prompts
  • Review all documentation files to identify places needing updates
  • Verify lint, build, and tests pass before changes
  • Update /docs/how-to/use-selectors.md - replace fix-bug with /fix-bug
  • Update /docs/how-to/use-remote-directories.md - replace fix-bug with /fix-bug
  • Update /docs/how-to/use-with-ai-agents.md - replace fix-bug with /fix-bug
  • Update /docs/how-to/create-rules.md - replace fix-bug with /fix-bug
  • Update /docs/how-to/github-actions.md - replace fix-bug with /fix-bug
  • Update /docs/reference/file-formats.md - replace fix-bug with /fix-bug
  • Update /docs/tutorials/getting-started.md - replace fix-bug with /fix-bug
  • Update /docs/index.md - replace fix-bug with /fix-bug
  • Update /docs/explanation/agentic-workflows.md - replace fix-bug with /fix-bug
  • Update /docs/explanation/architecture.md - replace fix-bug with /fix-bug
  • Update README.md - replace fix-bug with /fix-bug
  • Verify lint, build, and tests pass after changes
  • Run code review and address feedback
  • Run security check (CodeQL)

Summary

Updated all documentation examples to consistently use slash commands (e.g., /fix-bug) instead of bare task names (e.g., fix-bug). This aligns with the CLI's documented task-prompt format which supports:

  1. Free-text prompts (used directly as task content)
  2. Slash commands (e.g., /fix-bug) which trigger task file lookup
  3. Slash commands with arguments (e.g., /fix-bug 123)

All 11 documentation files were updated with no functional changes to the code.

Original prompt

The docs are full of examples of using a task name (e.g.fix-bug) rather than a slash command or free-text.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

…ames

Co-authored-by: alexec <1142830+alexec@users.noreply.github.com>
@alexec alexec marked this pull request as ready for review December 2, 2025 05:36
@alexec alexec enabled auto-merge (squash) December 2, 2025 05:36
@alexec alexec merged commit 1e58a1f into main Dec 2, 2025
2 checks passed
@alexec alexec deleted the copilot/update-documentation-examples branch December 2, 2025 05:37
Copilot AI requested a review from alexec December 2, 2025 05:37
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.

2 participants