Skip to content

Commit da338f5

Browse files
committed
Update blog post directory structure to include descriptive titles in AGENTS.md.
1 parent 31cea6c commit da338f5

1 file changed

Lines changed: 10 additions & 6 deletions

File tree

AGENTS.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,8 @@ This is the **Weekly Dev Chat** website, a static site built with MkDocs Materia
4747
│ └── YYYY/
4848
│ └── MM/
4949
│ └── DD/
50-
│ └── index.md # Blog post content
50+
│ └── YYYY-MM-DD-title-of-post/
51+
│ └── index.md # Blog post content
5152
├── assets/ # Images, logos, fonts, design files
5253
│ └── logo/ # Site branding assets
5354
└── stylesheets/
@@ -104,7 +105,9 @@ Each author has a name, description, and avatar URL.
104105
## Blog Post Conventions
105106

106107
### File Structure
107-
Blog posts are organized by date: `docs/posts/YYYY/MM/DD/index.md`
108+
Blog posts are organized by date with descriptive titles: `docs/posts/YYYY/MM/DD/YYYY-MM-DD-title-of-post/index.md`
109+
110+
This naming convention allows for multiple posts on the same day by using different descriptive titles.
108111

109112
### Post Frontmatter
110113
```yaml
@@ -254,7 +257,7 @@ The following are ignored:
254257
- `docs/join.md` - Join instructions
255258
- `docs/hosts/index.md` - Current hosts information
256259
- `docs/sponsors/index.md` - Sponsor information
257-
- `docs/posts/YYYY/MM/DD/index.md` - Blog posts
260+
- `docs/posts/YYYY/MM/DD/YYYY-MM-DD-title/index.md` - Blog posts
258261

259262
### For Configuration Changes
260263
- `mkdocs.yml` - Site configuration, theme, plugins, navigation
@@ -264,14 +267,15 @@ The following are ignored:
264267
### For Assets
265268
- `docs/assets/logo/` - Logo files (PNG, SVG)
266269
- `docs/assets/logo/Favicons/` - Favicon files
267-
- `docs/posts/YYYY/MM/DD/` - Post-specific images
270+
- `docs/posts/YYYY/MM/DD/YYYY-MM-DD-title/` - Post-specific images
268271

269272
## Common Agent Tasks
270273

271274
### Creating a New Blog Post
272275

273276
1. **Determine the date**: Calculate next Tuesday or use provided date
274-
2. **Create directory**: `docs/posts/YYYY/MM/DD/`
277+
2. **Create directory**: `docs/posts/YYYY/MM/DD/YYYY-MM-DD-descriptive-title/`
278+
- Example: `docs/posts/2026/01/13/2026-01-13-ai-coding-assistants/`
275279
3. **Create index.md** with proper frontmatter:
276280
```yaml
277281
---
@@ -331,7 +335,7 @@ The following are ignored:
331335

332336
1. **Never modify** `.github/workflows/ci.yml` unless explicitly requested - deployment is automated and stable
333337
2. **Always test locally** before pushing changes to main branch
334-
3. **Blog posts must follow** the date-based directory structure: `YYYY/MM/DD/`
338+
3. **Blog posts must follow** the date-based directory structure with descriptive title: `YYYY/MM/DD/YYYY-MM-DD-title-of-post/`
335339
4. **Frontmatter is required** for all blog posts (title, date, authors)
336340
5. **Images for blog posts** should be placed in the same directory as the post's `index.md`
337341
6. **The site uses** Material for MkDocs theme - refer to https://squidfunk.github.io/mkdocs-material/ for advanced features

0 commit comments

Comments
 (0)