Skip to content

Commit 492bcc8

Browse files
Copilotleecalcote
andcommitted
Add comprehensive documentation for blog-writer agent
Co-authored-by: leecalcote <7570704+leecalcote@users.noreply.github.com>
1 parent e5d9c10 commit 492bcc8

4 files changed

Lines changed: 577 additions & 0 deletions

File tree

.github/agents/QUICK_REFERENCE.md

Lines changed: 240 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,240 @@
1+
# blog-writer Agent Quick Reference
2+
3+
A quick reference card for using the blog-writer custom agent.
4+
5+
## Basic Syntax
6+
7+
```
8+
@blog-writer [Create/Write] a blog post about [topic]
9+
```
10+
11+
## Common Tags (by usage frequency)
12+
13+
| Tag | Uses | Tag | Uses |
14+
|-----|------|-----|------|
15+
| Open Source | 18 | Meshery | 15 |
16+
| Community | 14 | Kubernetes | 9 |
17+
| ai | 8 | Meet The Maintainer | 8 |
18+
| docker | 7 | Service Mesh | 2+ |
19+
20+
## Common Categories
21+
22+
- **Meshery** - Meshery product features
23+
- **Community** - Community news, events, spotlights
24+
- **Open Source** - Open source topics
25+
- **Kubernetes** - K8s-focused content
26+
- **Kanvas** - Kanvas features and guides
27+
- **Platform Engineering** - Platform engineering topics
28+
- **Cloud Native** - General cloud native content
29+
30+
## Required Components Checklist
31+
32+
- [ ] Frontmatter with all fields
33+
- [ ] BlogWrapper import and usage
34+
- [ ] At least 1 graphic/image
35+
- [ ] At least 1 CTA component
36+
- [ ] BlockQuote or BlockQuoteAlt
37+
- [ ] Multiple cross-page links
38+
- [ ] SEO-optimized title & description
39+
40+
## Component Quick Reference
41+
42+
### Imports
43+
```jsx
44+
import { BlogWrapper } from "../../Blog.style.js";
45+
import { Link } from "gatsby";
46+
import Blockquote from "../../../../reusecore/Blockquote";
47+
import BlockquoteAlt from "../../../../reusecore/Blockquote/Blockquote-alt-style";
48+
import CTA_FullWidth from "../../../../components/Call-To-Actions/CTA_FullWidth";
49+
```
50+
51+
### BlockQuote
52+
```jsx
53+
<Blockquote
54+
quote="Your impactful quote"
55+
person="Name"
56+
title="Title/Role"
57+
/>
58+
```
59+
60+
### CTA
61+
```jsx
62+
<CTA_FullWidth
63+
image={CTAImg}
64+
heading="Heading"
65+
alt="Alt text"
66+
content="Description"
67+
button_text="Button Text"
68+
url="/path"
69+
external_link={false}
70+
/>
71+
```
72+
73+
### Images
74+
```jsx
75+
// Import
76+
import myImage from "./my-image.png";
77+
78+
// Use
79+
<img src={myImage} className="image-center" alt="Alt text" />
80+
```
81+
82+
### Links
83+
```jsx
84+
<Link to="/cloud-native-management/meshery">Meshery</Link>
85+
```
86+
87+
### Special Divs
88+
```jsx
89+
<div class="intro">
90+
<p>Introductory text</p>
91+
</div>
92+
93+
<div class="note">
94+
<a href="url">Call to action</a>
95+
</div>
96+
97+
<div class="tip">
98+
<h3>Tip Title</h3>
99+
<p>Tip content</p>
100+
</div>
101+
```
102+
103+
## CSS Classes for Images
104+
105+
| Class | Effect |
106+
|-------|--------|
107+
| `image-left` | Float left with shadow |
108+
| `image-right` | Float right with shadow |
109+
| `image-left-no-shadow` | Float left, no shadow |
110+
| `image-right-no-shadow` | Float right, no shadow |
111+
| `image-center` | Center, full width |
112+
| `image-center-shadow` | Center with shadow |
113+
114+
## Common Link Destinations
115+
116+
| Type | Path |
117+
|------|------|
118+
| Meshery | `/cloud-native-management/meshery` |
119+
| Kanvas | `/cloud-native-management/meshery/design` |
120+
| Catalog | `/cloud-native-management/catalog` |
121+
| Community | `/community` |
122+
| Slack | `https://slack.layer5.io` |
123+
| Blog | `/blog` |
124+
| Resources | `/resources` |
125+
126+
## SEO Guidelines
127+
128+
- **Title**: 50-60 characters, keyword at start
129+
- **Description**: 150-160 characters, includes keywords
130+
- **URL**: Descriptive, under 60 chars, use hyphens
131+
- **H2/H3**: Include keywords naturally
132+
133+
## File Structure
134+
135+
```
136+
/src/collections/blog/YYYY/MM-DD-descriptive-slug/
137+
├── post.mdx (or index.mdx)
138+
├── image1.png
139+
├── image2.png
140+
└── ...
141+
```
142+
143+
## Frontmatter Template
144+
145+
```yaml
146+
---
147+
title: "Title Here"
148+
subtitle: "Subtitle here"
149+
date: YYYY-MM-DD HH:MM:SS -0530
150+
author: Author Name
151+
thumbnail: ./image.png
152+
darkthumbnail: ./image.png
153+
description: "Meta description here"
154+
type: Blog
155+
category: Category Name
156+
tags:
157+
- Tag1
158+
- Tag2
159+
featured: false
160+
published: true
161+
resource: true
162+
product: Meshery
163+
---
164+
```
165+
166+
## RSS Feed Rules
167+
168+
| Feed | Criteria |
169+
|------|----------|
170+
| Meshery Community | Category: Meshery/Announcements/Events AND tags: Community/Meshery/mesheryctl |
171+
| Main Blog | All posts |
172+
| Technical Posts | Exclude: Programs/Community/Events/FAQ |
173+
| News | All news items |
174+
175+
## Quick Prompts
176+
177+
### Feature Post
178+
```
179+
@blog-writer Feature announcement for [Product] - [Feature].
180+
Include use case, how-to, CTA.
181+
```
182+
183+
### Tutorial
184+
```
185+
@blog-writer Step-by-step tutorial: [Topic].
186+
Mark as resource. Include troubleshooting.
187+
```
188+
189+
### Community
190+
```
191+
@blog-writer Community post about [Event/Person].
192+
Use Community category and BlockQuote.
193+
```
194+
195+
### Technical
196+
```
197+
@blog-writer Technical deep-dive: [Topic].
198+
Include code examples, diagrams, best practices.
199+
```
200+
201+
## What Agent Handles
202+
203+
✅ Frontmatter structure
204+
✅ Component imports
205+
✅ Tag/category selection
206+
✅ SEO optimization
207+
✅ Required elements
208+
✅ Cross-linking
209+
✅ RSS feed consideration
210+
211+
## What You Review
212+
213+
📝 Technical accuracy
214+
📝 Tag relevance
215+
📝 Image descriptions
216+
📝 CTA destinations
217+
📝 Link validity
218+
📝 Overall tone
219+
220+
## Troubleshooting
221+
222+
| Problem | Solution |
223+
|---------|----------|
224+
| Wrong category | Specify in prompt: "use [Category] category" |
225+
| Missing component | Request explicitly: "include BlockQuote and CTA" |
226+
| Too technical | Add: "target audience: beginners/general" |
227+
| Not technical enough | Add: "target audience: engineers/architects" |
228+
| Need specific tags | List in prompt: "use tags: X, Y, Z" |
229+
230+
## Resources
231+
232+
- Full docs: `.github/agents/README.md`
233+
- Examples: `.github/agents/USAGE_EXAMPLES.md`
234+
- Template: `/src/collections/blog/blog-template/index.mdx`
235+
- Contributing: `CONTRIBUTING.md`
236+
- Style guide: `AGENTS.md`
237+
238+
---
239+
240+
**Pro Tip**: Start with a simple prompt, review the output, then refine with more specific requirements in a follow-up prompt.

0 commit comments

Comments
 (0)