Skip to content

Commit 21be223

Browse files
authored
Remove custom agents documentation from blog-writer.md
Removed sections on custom agents, including their workings, configuration format, guidelines, benefits, and troubleshooting. Signed-off-by: Lee Calcote <lee.calcote@layer5.io>
1 parent 1371722 commit 21be223

1 file changed

Lines changed: 0 additions & 65 deletions

File tree

.github/agents/blog-writer.md

Lines changed: 0 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -41,78 +41,13 @@ including information about design patterns and how users can contribute
4141
their own patterns to the catalog.
4242
```
4343

44-
## How Custom Agents Work
45-
46-
Custom agents are specialized configurations that give GitHub Copilot deep expertise in specific areas. They include:
47-
48-
1. **Domain Knowledge:** Understanding of Layer5's projects, style, and conventions
49-
2. **Structural Templates:** Knowledge of required file formats and structures
50-
3. **Best Practices:** Built-in guidelines for quality and consistency
51-
4. **Component Library:** Awareness of available React components and styles
52-
53-
## Agent Configuration Format
54-
55-
Each agent is defined in a YAML file with the following structure:
56-
57-
```yaml
58-
name: agent-name
59-
description: |
60-
Brief description of what the agent does
61-
(must start with "Custom agent:" for proper recognition)
62-
63-
instructions: |
64-
Detailed instructions and guidelines for the agent
65-
Includes templates, examples, and requirements
66-
```
67-
68-
## Adding New Custom Agents
69-
70-
To add a new custom agent:
71-
72-
1. Create a new YAML file in this directory (`.github/agents/`)
73-
2. Follow the naming convention: `agent-name.yml`
74-
3. Include a clear name and description (starting with "Custom agent:")
75-
4. Provide comprehensive instructions with examples
76-
5. Test the agent with GitHub Copilot
77-
6. Update this README with the new agent information
78-
79-
## Guidelines for Agent Instructions
80-
81-
When creating agent instructions:
82-
83-
- **Be Specific:** Include exact file paths, naming conventions, and requirements
84-
- **Provide Examples:** Show complete examples of expected output
85-
- **List Options:** Enumerate available choices (tags, categories, components)
86-
- **Include Constraints:** Specify what must be included and what should be avoided
87-
- **Reference Existing Code:** Point to template files and examples in the repository
88-
- **Consider Edge Cases:** Address common scenarios and special situations
89-
90-
## Benefits of Custom Agents
91-
92-
- **Consistency:** Ensures all outputs follow established patterns
93-
- **Efficiency:** Reduces time spent on boilerplate and formatting
94-
- **Quality:** Incorporates best practices automatically
95-
- **Onboarding:** Helps new contributors understand standards quickly
96-
- **Maintenance:** Centralizes knowledge that might otherwise be scattered
97-
98-
## Troubleshooting
99-
100-
If a custom agent isn't working as expected:
101-
102-
1. Verify YAML syntax: `python3 -c "import yaml; yaml.safe_load(open('agent-file.yml'))"`
103-
2. Check that description starts with "Custom agent:"
104-
3. Ensure instructions are clear and comprehensive
105-
4. Test with simple prompts first
106-
5. Gradually add complexity to your requests
107-
10844
## Resources
10945

11046
- [GitHub Copilot Documentation](https://docs.github.com/copilot)
11147
- [Layer5 Contributing Guidelines](../../CONTRIBUTING.md)
11248
- [Layer5 Blog Template](../../src/collections/blog/blog-template/index.mdx)
11349
- [Layer5 AGENTS.md](../../AGENTS.md)
11450

115-
11651
## Topics to never write about
11752
- service mesh
11853

0 commit comments

Comments
 (0)