Skip to content

Commit a3a8c40

Browse files
committed
docs: [UPDATE] Usable Public Documentation Template - Webhook-Ready Structure
Fragment ID: dc983960-2482-45a8-b604-0ae770797226 Path: src/content/docs/template/usable-public-documentation-template-webhook-ready-structure.md Auto-generated by N8N
1 parent b8fa87b commit a3a8c40

File tree

1 file changed

+10
-16
lines changed

1 file changed

+10
-16
lines changed

src/content/docs/template/usable-public-documentation-template-webhook-ready-structure.md

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,26 @@
11
---
22
title: "Usable Public Documentation Template - Webhook-Ready Structure"
3-
description: "Comprehensive documentation template for Usable Public workspace with webhook-ready metadata structure, consistent formatting guidelines, and section templates for auto-publishing to docs site"
3+
description: "Comprehensive documentation template for Usable Public workspace with webhook-ready structure, consistent formatting guidelines, and section templates for auto-publishing to docs site."
44
fragmentId: "dc983960-2482-45a8-b604-0ae770797226"
55
fragmentType: "Template"
66
createdBy: "unknown"
7-
createdAt: "2025-10-30T12:27:15.910Z"
8-
updatedAt: "2025-10-22T13:03:31.452Z"
7+
createdAt: "2025-10-30T12:27:21.958Z"
8+
updatedAt: "2025-10-22T13:38:28.084Z"
99
badges: []
1010
---
1111

1212
This template ensures consistent, webhook-ready documentation that can be automatically published to a docs site without manual adjustments.
1313

1414
## Template Structure
1515

16-
All documentation should include frontmatter metadata for webhook processing:
16+
**⚠️ IMPORTANT: DO NOT include YAML frontmatter in fragment content!**
1717

18-
```markdown
19-
---
20-
title: [Clear, Descriptive Title]
21-
category: [getting-started|concepts|tutorials|api-reference|integrations|troubleshooting]
22-
subcategory: [Optional: more specific categorization]
23-
tags: [tag1, tag2, tag3]
24-
difficulty: [beginner|intermediate|advanced]
25-
version: 1.0.0
26-
last_updated: YYYY-MM-DD
27-
author: [Author Name]
28-
---
29-
```
18+
The n8n webhook workflow automatically generates frontmatter from fragment metadata (fragmentId, fragmentType, createdBy, createdAt, updatedAt, etc.). Including frontmatter in the fragment content will cause double frontmatter and break the Astro parser.
19+
20+
**Correct:** Start directly with the H1 heading
21+
**Wrong:** Include `---` YAML frontmatter
22+
23+
The workflow will handle all metadata automatically.
3024

3125
## Required Sections
3226

0 commit comments

Comments
 (0)