Skip to content

Add admonition format check and relax knowledge_article_id rule#761

Merged
hilram7 merged 1 commit intodevfrom
add/derek-skill-updates
Apr 15, 2026
Merged

Add admonition format check and relax knowledge_article_id rule#761
hilram7 merged 1 commit intodevfrom
add/derek-skill-updates

Conversation

@hilram7
Copy link
Copy Markdown
Collaborator

@hilram7 hilram7 commented Apr 15, 2026

Summary

  • Two updates to the /derek KB article quality reviewer skill based on issues identified during testing on PR docs: add PPE supportability statement as KB article #752.
    • The admonition format check was missed entirely during that review — /derek did not flag :::note and :::tip blocks that needed converting to KB-style blockquote callouts.
    • The knowledge_article_id rule was too strict — it flagged articles written natively in the repo without a ZD/SF ID.

Changes

  • Admonition format check (new)/derek now flags Docusaurus admonition blocks (:::note, :::tip, :::warning, :::danger) in KB articles and tells the writer to convert them to blockquote callouts (> **NOTE:** or > **IMPORTANT:**). Vale handles inline "Note that" text — /derek handles admonition syntax. No overlap.
  • knowledge_article_id rule relaxed — field absent is no longer flagged. Only flagged if the field is present but empty. Articles written natively in the repo (not migrated from ZD/SF) will not have a ZD/SF ID, so requiring the field on all articles produced false positives.

Testing

  • Admonition format — tested on docs/kb/privilegesecure/remote-desktop-and-rds/configuring-the-netwrix-privilege-secure-rds-web-app-launcher.md, the only KB article with Docusaurus admonition syntax. /derek correctly flagged :::warning at line 58 with the admonition-format rule and included the converted blockquote text in the message. Vale did not flag the same block — correct separation of concerns confirmed.
  • knowledge_article_id absent — tested on docs/kb/passwordpolicyenforcer/ppe-supportability.md, which has no knowledge_article_id field. /derek found 3 other issues but did not flag the missing field. Rule change confirmed working.
  • knowledge_article_id present but empty — not tested against a real article (no suitable candidate available). Low-risk untested path.

- Flag Docusaurus admonition blocks (:::note, :::tip, :::warning,
  :::danger) in KB articles — writers should use blockquote callouts
  (> **NOTE:** / > **IMPORTANT:**) instead
- knowledge_article_id: only flag if the field is present but empty;
  absent field is acceptable for articles not migrated from Salesforce
@hilram7 hilram7 merged commit a4ae9db into dev Apr 15, 2026
5 checks passed
@hilram7 hilram7 deleted the add/derek-skill-updates branch April 15, 2026 03:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant