You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs(seo): update workflow and template with description rules
Update SEO article workflow documentation with new verification steps
and blog-draft template with frontmatter checklist emphasizing
description field best practices.
Co-Authored-By: Hagicode <noreply@hagicode.com>
Signed-off-by: newbe36524 <newbe36524@qq.com>
Copy file name to clipboardExpand all lines: SEO_ARTICLE_WORKFLOW.md
+13-10Lines changed: 13 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -165,7 +165,7 @@ Hermes generates an outline from the research note.
165
165
The outline must include:
166
166
167
167
- 3 title candidates
168
-
- 2 meta description candidates
168
+
- 2 meta description candidates, with one marked as the preferred top-level `description`
169
169
- H2 and H3 structure
170
170
- FAQ suggestions
171
171
- internal link placements
@@ -187,13 +187,21 @@ Hermes generates the article draft into `seo/drafts/` using the approved outline
187
187
Draft requirements:
188
188
189
189
- include frontmatter
190
+
- set a publishable top-level `description`
190
191
- use only approved facts
191
192
- use repository-aligned product naming
192
193
- include internal links from the brief where appropriate
193
194
- use concrete commands and file paths when relevant
194
195
- avoid keyword stuffing
195
196
- avoid generic AI filler language
196
197
198
+
Description rules:
199
+
200
+
- The top-level `description` field is the only publishable source of truth.
201
+
- Manual edits to `description` take priority over generated suggestions.
202
+
- If a draft starts from a generated lead paragraph, rewrite it before publication when the wording is generic, repetitive, or too close to the title.
203
+
- Do not move the description into `seo.description` or any other nested field.
204
+
197
205
The draft stays out of `src/content/docs/blog/` until it passes review.
198
206
199
207
### Stage 5: Self-review
@@ -217,19 +225,14 @@ Run repository checks before approval.
217
225
Current available verification commands:
218
226
219
227
```bash
228
+
npm run sync:blog-seo-descriptions
229
+
npm run sync:blog-seo-descriptions:write
230
+
npm run verify:blog-seo
220
231
npm run verify:blog
221
232
npm run build:verify-blog
222
233
```
223
234
224
-
Current repo checks validate blog structure and rendering, but they do not yet validate SEO workflow metadata. Add more checks over time.
225
-
226
-
Future recommended checks:
227
-
228
-
-`verify:seo-frontmatter`
229
-
-`verify:seo-source-traceability`
230
-
-`verify:seo-internal-links`
231
-
-`verify:seo-metadata-length`
232
-
-`verify:seo-duplicate-topics`
235
+
Current repo checks validate blog structure, rendering, and SEO description quality. Publication is blocked when `description` is missing, empty after normalization, over the hard limit, or effectively duplicates the title.
0 commit comments