mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2026-11-06 10:59:59 +00:00
2.4 KiB
2.4 KiB
Summary
Briefly describe the documentation-only change and the expected benefit.
Examples:
- Add missing setup instructions
- Fix incorrect or outdated documentation
- Restructure guides for better discoverability
Template Type
Select the primary intent of this PR:
- Feature - Adds or extends documentation content
- Fix - Repairs incorrect, outdated, or unclear documentation
Affected Documentation
List the touched documentation files and audience.
- Main files or sections changed:
- Target audience: developer, administrator, user, contributor, or reviewer
- Related code, workflow, or feature areas:
Change Type
Select the semantic version impact of this change:
- Major - Breaking change
- Minor - New backwards-compatible feature
- Patch - Small improvement or compatible adjustment
Change Details
Explain what changed and why.
Key points:
- What information was added, removed, corrected, or reorganized?
- What problem in the previous documentation does this solve?
- Does this change affect contributor, operator, or user behavior?
- Which alternatives were considered?
Validation
Describe how the documentation change was validated.
- Technical accuracy checked against the current implementation
- Broken wording, stale steps, or missing context reviewed
- Links, paths, commands, or references verified
Security Impact
Indicate whether this change has security implications.
- No relevant security impact
- Security impact present
If security impact is present, explain:
- Affected permissions, secrets, safety guidance, or exposed surfaces:
- Risk reduction, new exposure, or compatibility considerations:
- Security-specific validation performed:
Review Focus
Help reviewers focus on the riskiest parts of this PR. For repository-wide contribution and review expectations, see CONTRIBUTING.md.
- Highest-risk statements, commands, or assumptions:
- Accuracy, clarity, or audience-fit concerns:
- Specific feedback requested from reviewers:
Definition of Done (DoD)
- The implementation follows the Definition of Done, and the contribution guidelines in CONTRIBUTING.md were considered and applied during implementation.
Additional Notes
Add any reviewer context for follow-up docs work, migration notes, or open questions.