Skip to content

docs: Add integrations and prompt inputs to README#59

Open
Copilot wants to merge 2 commits intomainfrom
copilot/update-readme-integrations-prompt
Open

docs: Add integrations and prompt inputs to README#59
Copilot wants to merge 2 commits intomainfrom
copilot/update-readme-integrations-prompt

Conversation

Copy link
Contributor

Copilot AI commented Feb 27, 2026

integrations and prompt inputs were implemented in action.yml but missing from the README.

Changes

  • issue_body: Fixed typo ("he body" → "The body"), corrected default value to match action.yml, and added $RUN_URL and $PROMPT as documented template variables
  • integrations: New section documenting supported values (doc-sentinel, promptless, dosu, claude, opencode, copilot, cursor), warning behavior for invalid values, and the special copilot behavior (auto-assigns issue rather than appending to accordion)
  • prompt: New section documenting the default prompt text, how it maps to integration mentions (e.g. @claude <prompt>), and its availability as $PROMPT in issue_body
- uses: doc-detective/github-action@v1
  with:
    create_issue_on_fail: true
    integrations: claude,copilot
    prompt: Investigate the Doc Detective test failures and suggest fixes for the documentation.

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: hawkeyexl <5209367+hawkeyexl@users.noreply.github.com>
Copilot AI changed the title [WIP] Update readme for integrations and prompt inputs docs: Add integrations and prompt inputs to README Feb 27, 2026
@hawkeyexl hawkeyexl marked this pull request as ready for review February 27, 2026 21:14
Copilot AI review requested due to automatic review settings February 27, 2026 21:14
@hawkeyexl hawkeyexl enabled auto-merge (squash) February 27, 2026 21:14
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds documentation to the README for the integrations and prompt inputs that were already implemented in action.yml but not previously documented. It also fixes a typo and corrects the default value shown for issue_body.

Changes:

  • Fixed typo ("he body" → "The body") and updated the issue_body default to match action.yml, adding $RUN_URL and $PROMPT as documented template variables
  • Added new integrations section documenting supported values, invalid value behavior, and the special copilot behavior
  • Added new prompt section documenting the default text, integration usage, and $PROMPT availability in issue_body

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@promptless
Copy link

promptless bot commented Feb 27, 2026

📝 Documentation updates detected!

New suggestion: Add $PROMPT variable to issue_body description in CI docs


Tip: Worried about broken links? Ask Promptless to find and fix them automatically 🔗

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.

3 participants