docs: catch documentation up to code changes from #8 through #12#19
Merged
Conversation
Five docs lagged behind the merged feature work: - README.md — repo-layout tree (aap_config/, .claude/skills/, docs/); updated `schemes` example to [http, https] reflecting the post-#10 default; Output section now describes the firewall-rule punch list from #12. - docs/install-manual.md — drop "(coming soon)" reference; the AI doc shipped in #9. - CLAUDE.md — expanded file inventory; `ansible.builtin`-only claim scoped to the probe playbook (the loader in aap_config/ pulls infra.aap_configuration); CI lint scope corrected (also lints aap_config/ now); schemes example matches reality. - CONTRIBUTING.md — branch naming pattern aligned with what the recent PRs actually used (`<issue#>-<description>` for one-click traceability); failure-path test pattern updated to the cleaner `-e @<fixture>` approach used in #12. All grouped under one PR per the "docs catching up to code" rule — shared root cause, would be reverted together. Closes #18. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes #18.
Five docs lagged behind the feature work merged in #8 (aap_config/), #9 (AI install skill), #10 (http schemes), and #12 (firewall punch list output). All grouped under one PR per the "docs catching up to code" rule — same root cause, would be reverted together.
Changes by file
README.md— Added a repo-layout tree (aap_config/,.claude/skills/,docs/); updated theschemesexample from[https]to[http, https]reflecting the post-Add http scheme to URLs that require it per Red Hat KB 6972355 #10 default; rewrote the Output section to show the firewall-rule punch list from Failure output should print the firewall rule to allow for each miss #12.docs/install-manual.md— Dropped the "(coming soon)" footnote oninstall-with-ai.md— that doc shipped in Ship .claude/skills/url-checker-install/ skill for AI-assisted install path #9.CLAUDE.md(project) — Expanded the file inventory to cover the new top-level directories; scoped theansible.builtin-only claim to the probe playbook (the loader inaap_config/pullsinfra.aap_configuration); corrected the CI lint scope (also lintsaap_config/now); fixed theschemesexample.CONTRIBUTING.md— Branch naming pattern aligned with what the recent PRs actually used (<issue#>-<description>for one-click traceability from any commit to its issue); updated the failure-path test pattern to the cleaner-e @<fixture>approach used in Failure output should print the firewall rule to allow for each miss #12.CHANGELOG.md— Entry under[Unreleased] / Changed.Independent verification this session
Beyond local tests, the user ran the loaded JT once more against the live RHDP AAP after #10 merged — all 32 probes passed end-to-end on real infrastructure (job 23). So the docs now describe a code state that has been verified in production.
Test plan
yamllintclean locallyansible-lintclean locally🤖 Generated with Claude Code