Description
The AI doc review bot incorrectly flags valid announcement frontmatter fields as errors, recommending a format that does not exist in this repository. The bot appears to apply guidelines from a different documentation system (likely the dev portal release note format).
Affected PR: #753 — comment #4616614550
Incorrect Bot Recommendations
The bot flagged the following issues on a valid announcement file:
| Bot Claim |
Bot-Suggested Field |
Correct Field (this repo) |
"Missing type field" |
type: added |
Field does not exist in this repo |
| "Incorrect slug field" |
slug |
slugEN |
| "Incorrect excerpt field" |
excerpt |
announcementSynopsisPT / announcementSynopsisEN / announcementSynopsisES |
Evidence
The following existing announcement files confirm the correct frontmatter pattern for this repository:
All three use: contentType: updates, slugEN, announcementSynopsisPT, productTeam, locale — matching the pattern the bot incorrectly flagged.
The README.md (lines 50–174) and .github/scripts/check_frontmatter.py both confirm slugEN and announcementSynopsis{Locale} as the required fields.
Expected Behavior
The AI review bot should validate announcement frontmatter against the help-center-content conventions, not those of another documentation system.
Investigation Notes
Related Files
Suggested Investigation Paths
- Identify the configuration or knowledge source the AI review bot uses to validate announcement frontmatter
- Align the bot's announcement schema with the fields documented in
README.md and enforced by check_frontmatter.py
- Verify the bot does not inherit release note guidelines from the dev portal documentation system
Description
The AI doc review bot incorrectly flags valid announcement frontmatter fields as errors, recommending a format that does not exist in this repository. The bot appears to apply guidelines from a different documentation system (likely the dev portal release note format).
Affected PR: #753 — comment #4616614550
Incorrect Bot Recommendations
The bot flagged the following issues on a valid announcement file:
typefield"type: addedslugslugENexcerptannouncementSynopsisPT/announcementSynopsisEN/announcementSynopsisESEvidence
The following existing announcement files confirm the correct frontmatter pattern for this repository:
docs/pt/announcements/2025/setembro/2025-09-10-nova-funcionalidade-definir-limite-de-orcamento-por-promocao.mddocs/pt/announcements/2025/setembro/2025-09-01-checkout-nova-validacao-do-recaptcha.mddocs/pt/announcements/2025/setembro/2025-09-08-novo-formulario-de-promocao-de-campanha.mdAll three use:
contentType: updates,slugEN,announcementSynopsisPT,productTeam,locale— matching the pattern the bot incorrectly flagged.The
README.md(lines 50–174) and.github/scripts/check_frontmatter.pyboth confirmslugENandannouncementSynopsis{Locale}as the required fields.Expected Behavior
The AI review bot should validate announcement frontmatter against the
help-center-contentconventions, not those of another documentation system.Investigation Notes
Related Files
.github/scripts/check_frontmatter.py— programmatic frontmatter validation (Python); enforcesslugENas required field.github/workflows/check-frontmatter.yml— GitHub Actions workflow that runs the frontmatter check on PRsREADME.md— documents required announcement frontmatter fields (lines 50–174)Suggested Investigation Paths
README.mdand enforced bycheck_frontmatter.py