[RHIDP#12779]: CQA tooling optimization and content modularization#1947
Conversation
- Rewrite CQA scripts (01, 02, 03) for correctness and brevity - Fix empty-line bug in list-all-included-files-starting-from.sh - Create condensed CQA extracts for SSG, peer review, and content types - Convert peer review resource from HTML to Markdown - Remove redundant resources (cqa-common-issues, vale-acceptable-warnings) - Clean stale permissions in .claude/settings.json - Update skill files to match rewritten scripts - Fix cqa-04 template ordering (content type first) and procedure title form Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Add 11 auto-fixes: content type, context save/restore, prerequisites heading, additional resources, ID suffix, context line positioning - Enforce assembly template structure: content type line 1, context save line 2, context restore as last two lines - Add checks: intro length, prerequisites count, prerequisites format, ID suffix, additional resources role attribute - Script now resolves 99% of violations across all 33 titles (497 → 6) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add auto-fix support for DITA Vale issues (AuthorLine, CalloutList, BlockTitle, TaskContents, TaskStep) and apply fixes across all titles. Standardize all 16 CQA skill files to follow a consistent 6-step workflow: report, auto-fix, verify, manual fix, re-verify, report. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
🐚 Shellcheck Analysis ResultsChanged shell scripts in this PR: 4 Scripts analyzed:
💡 Check the Files changed tab for detailed shellcheck suggestions. All findings are reported as warnings and won't block the PR. Automated shellcheck analysis • See shellcheck.net for details |
📋 Content Quality Assessment ResultsChanged .adoc files in this PR: 14 🗑️ Orphaned Modules Check✅ No orphaned files found 📝 Content Type Validation💡 Code suggestions posted for content type fixes 🏷️ Title/ID/Filename Alignment✅ All changed files have aligned title/ID/filename Automated CQA check • See CQA.md for manual verification steps |
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
🐚 Shellcheck Analysis ResultsChanged shell scripts in this PR: 4 Scripts analyzed:
💡 Check the Files changed tab for detailed shellcheck suggestions. All findings are reported as warnings and won't block the PR. Automated shellcheck analysis • See shellcheck.net for details |
|
Updated preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-1947/ @ 03/19/26 18:05:23 |
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
🐚 Shellcheck Analysis ResultsChanged shell scripts in this PR: 4 Scripts analyzed:
💡 Check the Files changed tab for detailed shellcheck suggestions. All findings are reported as warnings and won't block the PR. Automated shellcheck analysis • See shellcheck.net for details |
📋 Content Quality Assessment ResultsChanged .adoc files in this PR: 15 🗑️ Orphaned Modules Check✅ No orphaned files found 📝 Content Type Validation💡 Code suggestions posted for content type fixes 🏷️ Title/ID/Filename Alignment✅ All changed files have aligned title/ID/filename Automated CQA check • See CQA.md for manual verification steps |
….md) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
🐚 Shellcheck Analysis ResultsChanged shell scripts in this PR: 4 Scripts analyzed:
💡 Check the Files changed tab for detailed shellcheck suggestions. All findings are reported as warnings and won't block the PR. Automated shellcheck analysis • See shellcheck.net for details |
|
Updated preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-1947/ @ 03/19/26 18:14:19 |
TaskStep autofix now distinguishes two cases: - After .Procedure before first step: remove erroneous blank line - After a list: attach to preceding step with + continuation Also fixes two .adoc files with erroneous + after .Procedure. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
📋 Content Quality Assessment ResultsChanged .adoc files in this PR: 122 🗑️ Orphaned Modules Check✅ No orphaned files found 📝 Content Type Validation💡 Code suggestions posted for content type fixes 🏷️ Title/ID/Filename Alignment✅ All changed files have aligned title/ID/filename Automated CQA check • See CQA.md for manual verification steps |
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
🐚 Shellcheck Analysis ResultsChanged shell scripts in this PR: 25 Scripts analyzed:
💡 Check the Files changed tab for detailed shellcheck suggestions. All findings are reported as warnings and won't block the PR. Automated shellcheck analysis • See shellcheck.net for details |
📋 Content Quality Assessment ResultsChanged .adoc files in this PR: 123 🗑️ Orphaned Modules Check✅ No orphaned files found 📝 Content Type Validation💡 Code suggestions posted for content type fixes 🏷️ Title/ID/Filename Alignment✅ All changed files have aligned title/ID/filename Automated CQA check • See CQA.md for manual verification steps |
themr0c
changed the title
🐚 Shellcheck Analysis ResultsChanged shell scripts in this PR: 25 Scripts analyzed:
💡 Check the Files changed tab for detailed shellcheck suggestions. All findings are reported as warnings and won't block the PR. Automated shellcheck analysis • See shellcheck.net for details |
📋 Content Quality Assessment ResultsChanged .adoc files in this PR: 123 🗑️ Orphaned Modules Check✅ No orphaned files found 📝 Content Type Validation💡 Code suggestions posted for content type fixes 🏷️ Title/ID/Filename Alignment✅ All changed files have aligned title/ID/filename Automated CQA check • See CQA.md for manual verification steps |
- Fix 11 broken cross-references caused by cross-assembly context mismatches (ccutil build now passes for all 33 titles) - Update shellcheck workflow to always update existing PR comment - Add PR template and post-push rules to CLAUDE.md Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
🐚 Shellcheck Analysis ResultsChanged shell scripts in this PR: 25 Scripts analyzed:
💡 Check the Files changed tab for detailed shellcheck suggestions. All findings are reported as warnings and won't block the PR. Automated shellcheck analysis • See shellcheck.net for details |
|
Updated preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-1947/ @ 03/20/26 10:37:57 |
Address all SonarCloud code analysis warnings: - Add explicit return statements at end of functions across all CQA scripts - Assign positional parameters to local variables (cqa-00, cqa-02, cqa-03) - Merge nested if statements (cqa-01, cqa-17) - Define constants for repeated string literals (cqa-lib checklist, cqa-00 shared, cqa-03 include pattern) - Add default case to case statement (cqa-01) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
🐚 Shellcheck Analysis ResultsChanged shell scripts in this PR: 25 Scripts analyzed:
💡 Check the Files changed tab for detailed shellcheck suggestions. All findings are reported as warnings and won't block the PR. Automated shellcheck analysis • See shellcheck.net for details |
|
|
Updated preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-1947/ @ 03/20/26 10:53:47 |
2 participants
Important
Do Not Merge
This PR contains CQA tooling improvements and documentation structure changes. Review each commit individually.
Version(s): All
Issue: RHIDP-12779
Preview: N/A (script changes only, no content changes to preview)
Summary
Comprehensive CQA tooling optimization and content modularization:
CQA Script Improvements
:imagesdir:fallback toartifacts/attributes.adocContent Structure
master.adocfor two titles (extend plugins, MCP tools)master.adocfiles into concept modules (install methods, adoption insights, audit logs):abstract:attribute and use{abstract}referenceCI/CD
shellcheck.ymlto always update existing PR comments (not just when files changed)Checklist