Skip to content

AI skills for creating and fixing docs#650

Open
gaurav-nelson wants to merge 2 commits intovalidatedpatterns:mainfrom
gaurav-nelson:ai_skills
Open

AI skills for creating and fixing docs#650
gaurav-nelson wants to merge 2 commits intovalidatedpatterns:mainfrom
gaurav-nelson:ai_skills

Conversation

@gaurav-nelson
Copy link
Collaborator

This pull request introduces a new documentation creation and review AI skills.

Key changes:

1. New skill: Automated documentation review (doc-review)

  • Introduces the doc-review skill to review and fix documentation files for compliance with the Red Hat/IBM Style Guide, supporting both AsciiDoc and Markdown formats with format-aware rule application.
  • Details the review workflow, severity classification, and fix application process, referencing 24 specific style guides. (.rulesync/skills/doc-review/SKILL.md)

2. New skill: Automated documentation creation (doc-create)

  • Introduces the doc-create skill with a step-by-step workflow for generating new documentation pages for both "learn" and "pattern" content types, including metadata collection, file structure, AsciiDoc/Markdown templates, and required style checks.
  • Enforces adherence to naming conventions, file structure, and content quality, with built-in quick and full style review steps. (.rulesync/skills/doc-create/SKILL.md)

@openshift-ci openshift-ci bot requested review from beekhof and mbaldessari March 3, 2026 09:13
@openshift-ci openshift-ci bot added the size/XXL label Mar 3, 2026
@gaurav-nelson gaurav-nelson changed the title AI skills for creating and fix docs AI skills for creating and fixing docs Mar 3, 2026
@ocpdocs-previewbot
Copy link

🤖 Tue Mar 03 09:20:16 - The preview is ready at:
https://650--patternsdocs-pr.netlify.app

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants