Add GitHub Copilot agent for article review and consistency#405
Add GitHub Copilot agent for article review and consistency#405noahtigner merged 5 commits intomainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This PR introduces a GitHub Copilot “article-reviewer” agent spec and companion docs to standardize how technical blog articles in src/assets/articles/ are reviewed for style consistency, markdown correctness, and reading-time calculation.
Changes:
- Added a dedicated agent specification for light-touch technical article editing and validation.
- Documented how to use the agent with practical, copy/pasteable scenarios.
- Added an agents directory README describing available agents and recommended workflows.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| .github/agents/article-reviewer.md | Defines the article review agent’s style guide, checklists, and reading-time calculation procedure. |
| .github/agents/USAGE_EXAMPLES.md | Provides concrete prompts and expected outputs for using the agent in day-to-day writing/editing. |
| .github/agents/README.md | Documents the agents directory and summarizes what the article-reviewer agent does/doesn’t do. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
@copilot Are the ./github/agents/README.md and ./github/agents/USAGE_EXAMPLES.md actually necessary? Are they helpful for the agents? I will not need them. If not, remove them both |
Removed both README.md and USAGE_EXAMPLES.md in ae60c14. These files were documentation for humans, not necessary for the agent to function. The article-reviewer.md agent spec contains all the guidance needed for GitHub Copilot. |
Co-authored-by: noahtigner <46695778+noahtigner@users.noreply.github.com>
Co-authored-by: noahtigner <46695778+noahtigner@users.noreply.github.com>
- Rename "Emphasis" to "Links" for clarity - Clarify "Headers" description to specify in-body heading - Remove README.md and USAGE_EXAMPLES.md (not needed for agent) Co-authored-by: noahtigner <46695778+noahtigner@users.noreply.github.com>
ae60c14 to
485135e
Compare
|
@copilot review this article |
GitHub Copilot agent specification for technical article editing with style analysis, grammar checking, markdown validation, and automated reading time calculation.
Implementation
.github/agents/article-reviewer.md- Agent specification with writing guidelines extracted from 5 existing articlessed -n '/^##/,$p' article.md | wc -w÷ 200 WPMUsage
The agent validates markdown conventions specific to this blog:
<a href="..." target="_blank" rel="noopener">> [!NOTE],> [!TIP],> [!WARNING]minutesToReadcalculated from content word countReading time calculation excludes frontmatter and uses 200 WPM baseline for semi-technical content with code examples.
Notes
The agent requires only the specification file itself to function. Additional documentation files (README, usage examples) are not necessary for GitHub Copilot to use the agent.
Original prompt
Created from VS Code.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.