Skip to content

Conversation

@adegeo
Copy link
Contributor

@adegeo adegeo commented Dec 2, 2025

This moves the editing prompt content to an agent that can be used on GitHub or in VSCode.

Prompts aren't used on GitHub, but can be used from VSCode. The prompt was updated to invoke the agent with a simple instruction to edit the current article.

@gewarren


Internal previews

📄 File 🔗 Preview link
.github/agents/doceditor.agent.md Article Editing Instructions for LLMs
.github/prompts/Editing.FullPass.prompt.md Article Editing Instructions

@adegeo adegeo requested a review from gewarren December 2, 2025 21:30
@adegeo adegeo requested a review from a team as a code owner December 2, 2025 21:30
Copilot AI review requested due to automatic review settings December 2, 2025 21:30
@dotnetrepoman dotnetrepoman bot added this to the December 2025 milestone Dec 2, 2025
Copilot finished reviewing on behalf of adegeo December 2, 2025 21:32
Copy link
Contributor

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 refactors the editing prompt structure by extracting the comprehensive editing instructions into a reusable agent definition, allowing the agent to be invoked both from GitHub and VS Code. The prompt file now simply references the agent with a brief instruction.

  • The detailed Microsoft Style Guide editing instructions (230 lines) have been moved to a new agent file
  • The prompt file is simplified to invoke the agent with a concise instruction
  • The mode: agent frontmatter field is replaced with agent: DocsEditor to reference the new agent

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
.github/prompts/Editing.FullPass.prompt.md Simplified to a 9-line prompt that references the DocsEditor agent with a brief editing instruction
.github/agents/doceditor.agent.md New agent definition containing the comprehensive 230-line editing instructions for transforming documentation according to Microsoft Style Guide

Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe name the file docseditor.agent.md to match the name exactly.

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