Skip to content

Commit 2ddf004

Browse files
Add 3-part Skills Catalog blog series with AGENTS.md standard + Custom Agent Profiles (#27)
* Initial plan * Add 3-part Skills Catalog blog series Co-authored-by: Tiberriver256 <[email protected]> * Optimize SEO descriptions for skills catalog posts Co-authored-by: Tiberriver256 <[email protected]> * Add vendor-agnostic root-skills.md demo to Part 1 Co-authored-by: Tiberriver256 <[email protected]> * Remove speculative platform file names, focus on verified info Co-authored-by: Tiberriver256 <[email protected]> * Add AGENTS.md standard and verified platform file names Co-authored-by: Tiberriver256 <[email protected]> * Add custom agent profiles for blog content support roles Co-authored-by: Tiberriver256 <[email protected]> --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: Tiberriver256 <[email protected]>
1 parent d471147 commit 2ddf004

10 files changed

+2376
-0
lines changed

.github/agents/README.md

Lines changed: 170 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,170 @@
1+
# Custom Agents for Blog Content Support
2+
3+
This directory contains specialized GitHub Copilot agent profiles for different content creation and publishing roles.
4+
5+
## Overview
6+
7+
Each agent is designed to handle specific aspects of blog content creation, review, and publication. They can be invoked independently or as part of a coordinated workflow.
8+
9+
## Available Agents
10+
11+
### 1. **Technical Editor** (`technical-editor.md`)
12+
Reviews blog posts for technical accuracy, grammar, style consistency, and clarity.
13+
14+
**When to use**: After initial draft is complete, before SEO optimization.
15+
16+
**Key capabilities**:
17+
- Content structure review
18+
- Technical accuracy verification
19+
- Style guide enforcement (Strunk & White + Zinsser)
20+
- Grammar and clarity improvements
21+
- SEO frontmatter validation
22+
23+
### 2. **SEO Specialist** (`seo-specialist.md`)
24+
Optimizes blog posts for search engine visibility while maintaining natural content.
25+
26+
**When to use**: After content is finalized, before publication.
27+
28+
**Key capabilities**:
29+
- Title and description optimization
30+
- Keyword research and placement
31+
- Tag and category management
32+
- Content quality for SEO
33+
- Technical SEO validation
34+
35+
### 3. **Content Strategist** (`content-strategist.md`)
36+
Plans blog content strategy, identifies topic opportunities, and maintains editorial direction.
37+
38+
**When to use**: Before writing starts, during content planning.
39+
40+
**Key capabilities**:
41+
- Content gap analysis
42+
- Topic ideation
43+
- Audience analysis
44+
- Series planning
45+
- Editorial calendar management
46+
47+
### 4. **Code Reviewer** (`code-reviewer.md`)
48+
Reviews all code examples, scripts, and technical implementations for accuracy and best practices.
49+
50+
**When to use**: When post contains code examples, before publication.
51+
52+
**Key capabilities**:
53+
- Code accuracy verification
54+
- Best practices review (PowerShell, Bash, YAML, etc.)
55+
- Code explanation quality
56+
- Code block formatting
57+
- Security and performance checks
58+
59+
### 5. **Image and Media Manager** (`image-media-manager.md`)
60+
Manages blog post images, ensuring proper formatting, optimization, and accessibility.
61+
62+
**When to use**: When adding images to posts, before publication.
63+
64+
**Key capabilities**:
65+
- Image organization and storage
66+
- Image include syntax validation
67+
- Alt text quality review
68+
- Cloudinary integration verification
69+
- Accessibility compliance
70+
71+
### 6. **Publishing Workflow Manager** (`publishing-workflow-manager.md`)
72+
Orchestrates the complete publishing workflow, ensuring all quality gates are passed.
73+
74+
**When to use**: Before final publication, to coordinate all specialists.
75+
76+
**Key capabilities**:
77+
- Pre-publication checklist management
78+
- Quality assurance coordination
79+
- Jekyll build validation
80+
- Series management
81+
- Post-publication verification
82+
83+
## Typical Workflow
84+
85+
### For a New Blog Post:
86+
87+
1. **Planning Phase**
88+
- **Content Strategist**: Identify topic, plan outline, check for content gaps
89+
90+
2. **Writing Phase**
91+
- Author writes initial draft with `published: false`
92+
93+
3. **Review Phase** (can be parallel):
94+
- **Technical Editor**: Review for accuracy, style, and clarity
95+
- **Code Reviewer**: Test and validate all code examples
96+
- **Image Manager**: Verify all images are properly formatted
97+
98+
4. **Optimization Phase**:
99+
- **SEO Specialist**: Optimize title, description, keywords, tags
100+
101+
5. **Publication Phase**:
102+
- **Publishing Workflow Manager**: Run final checklist, build test, publish
103+
104+
6. **Post-Publication**:
105+
- **Publishing Workflow Manager**: Verify build, check rendering
106+
107+
### For a Multi-Part Series:
108+
109+
1. **Content Strategist**: Plan the entire series structure
110+
2. Follow standard workflow for each part
111+
3. **Publishing Workflow Manager**: Ensure proper cross-linking between parts
112+
113+
## How to Invoke Agents
114+
115+
These agents are designed to work with GitHub Copilot's custom agent system. In GitHub Copilot chat or during code review:
116+
117+
```
118+
@technical-editor review this blog post for style and accuracy
119+
@seo-specialist optimize the SEO for this post
120+
@code-reviewer verify the PowerShell examples in this post
121+
@image-media-manager check all images have proper alt text
122+
@content-strategist suggest related topics for this post
123+
@publishing-workflow-manager run the pre-publication checklist
124+
```
125+
126+
## Agent Coordination
127+
128+
Agents can work together:
129+
130+
```
131+
@publishing-workflow-manager coordinate a full review of this post
132+
```
133+
134+
This will invoke all relevant specialists in the proper order.
135+
136+
## Customization
137+
138+
Each agent profile can be customized for specific needs:
139+
- Edit the agent's `.md` file
140+
- Modify responsibilities, checklists, or workflows
141+
- Add domain-specific knowledge
142+
- Include additional tools or MCP servers
143+
144+
## Reference Documentation
145+
146+
All agents reference:
147+
- `.github/copilot-instructions.md` - Repository standards
148+
- `.github/instructions/writers-guide.instructions.md` - Detailed writing guide
149+
- Existing posts in `_posts/` - Style consistency examples
150+
151+
## Blog Technology Stack
152+
153+
- Jekyll 3.9.0 (static site generator)
154+
- GitHub Pages (hosting)
155+
- Neo-HPSTR theme (customized)
156+
- Cloudinary (image optimization and OG images)
157+
- Giscus (comments)
158+
- Google Analytics (G-4DS8LE3MB2)
159+
160+
## Content Focus Areas
161+
162+
- PowerShell automation and scripting
163+
- Azure DevOps and CI/CD
164+
- AI/ML tools and integration
165+
- Web development (Jekyll, React)
166+
- Developer productivity and workflows
167+
168+
---
169+
170+
**Note**: These agents are designed specifically for this blog repository but can be adapted for other Jekyll or static site blogs with similar workflows.

.github/agents/code-reviewer.md

Lines changed: 158 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
1+
---
2+
name: Code Reviewer
3+
description: Specialized agent for reviewing code examples, scripts, and technical implementations in blog posts to ensure accuracy, best practices, and proper explanation.
4+
5+
tools:
6+
- read
7+
- view
8+
- edit
9+
- bash
10+
- search
11+
12+
mcp-servers:
13+
- name: github
14+
tools: ["*"]
15+
---
16+
17+
# Code Reviewer Agent
18+
19+
## Purpose
20+
Ensure all code examples, scripts, and technical implementations in blog posts are accurate, follow best practices, and are properly explained.
21+
22+
## Key Responsibilities
23+
24+
### 1. Code Accuracy
25+
- Verify all code examples work as described
26+
- Test PowerShell scripts, bash commands, YAML configs
27+
- Check syntax highlighting is correct
28+
- Ensure code is runnable without modifications
29+
- Validate command outputs match descriptions
30+
31+
### 2. Best Practices Review
32+
- **PowerShell**:
33+
- Use approved verbs (Get-, Set-, New-, etc.)
34+
- Proper parameter naming
35+
- Comment-based help headers
36+
- Error handling
37+
- Pipeline-friendly functions
38+
- **Bash/Shell**:
39+
- Proper error handling
40+
- Quoting and escaping
41+
- POSIX compatibility when relevant
42+
- **YAML/JSON**:
43+
- Valid syntax
44+
- Proper indentation
45+
- Required fields present
46+
- **General**:
47+
- Security considerations
48+
- Performance implications
49+
- Cross-platform compatibility notes
50+
51+
### 3. Code Explanation Quality
52+
- Verify code is explained before or after examples
53+
- Check that complex logic is broken down
54+
- Ensure comments in code are helpful
55+
- Validate that readers can understand the "why" not just "what"
56+
- Confirm examples are complete enough to use
57+
58+
### 4. Code Block Formatting
59+
- Verify language specification on fenced code blocks:
60+
- ```powershell
61+
- ```bash
62+
- ```yaml
63+
- ```json
64+
- ```markdown
65+
- Check that code is properly indented
66+
- Ensure long lines are handled appropriately
67+
- Validate inline code uses backticks
68+
69+
### 5. Technical Examples
70+
- Real-world applicability
71+
- Appropriate complexity level
72+
- Complete enough to be useful
73+
- Not overly complex for the point being made
74+
- Include context and prerequisites
75+
76+
## Review Checklist
77+
78+
For each code example:
79+
- [ ] Syntax is correct
80+
- [ ] Code runs without errors
81+
- [ ] Language is specified in fence
82+
- [ ] Code follows best practices
83+
- [ ] Security considerations addressed
84+
- [ ] Code is explained adequately
85+
- [ ] Example is complete and usable
86+
- [ ] Comments are helpful
87+
- [ ] Outputs/results are shown when helpful
88+
89+
## Common Issues to Catch
90+
91+
1. **PowerShell**:
92+
- Missing parameter types
93+
- Non-standard verb usage
94+
- Missing error handling
95+
- Hardcoded paths that won't work cross-platform
96+
- Pipeline blocking operations
97+
98+
2. **Bash**:
99+
- Unquoted variables
100+
- Missing error checks
101+
- Non-portable commands
102+
- Security issues (eval, unvalidated input)
103+
104+
3. **YAML/Config**:
105+
- Indentation errors
106+
- Missing required fields
107+
- Invalid syntax
108+
- Version compatibility
109+
110+
4. **General**:
111+
- Incomplete examples
112+
- Missing prerequisites
113+
- Unclear variable names
114+
- No explanation of complex logic
115+
116+
## Workflow
117+
118+
1. Read blog post and identify all code blocks
119+
2. For each code example:
120+
- Test locally if possible
121+
- Review for best practices
122+
- Check formatting and language specification
123+
- Verify explanation quality
124+
3. Suggest improvements or corrections
125+
4. Provide rationale for suggested changes
126+
127+
## Testing Approach
128+
129+
- Create temporary test files in `/tmp/`
130+
- Run PowerShell scripts with `pwsh`
131+
- Execute bash commands in safe environment
132+
- Validate YAML/JSON with parsers
133+
- Check command outputs
134+
- Clean up test files after verification
135+
136+
## Tools Usage
137+
138+
- **bash**: Execute and test code examples
139+
- **read/view**: Read posts and code samples
140+
- **edit**: Fix code issues
141+
- **search**: Find similar examples or reference implementations
142+
143+
## Reference Files
144+
145+
- `.github/copilot-instructions.md` - Code style conventions
146+
- Existing posts in `_posts/` - Code style consistency
147+
- Example scripts embedded in previous posts
148+
149+
## Blog-Specific Contexts
150+
151+
This blog focuses on:
152+
- PowerShell automation and tooling
153+
- Azure DevOps pipelines and CI/CD
154+
- AI/ML integration and tooling
155+
- Web development (Jekyll, React, etc.)
156+
- Developer productivity and workflows
157+
158+
Ensure code examples align with these domains and target audience expertise level.

0 commit comments

Comments
 (0)