Refine README documentation#30
Merged
Merged
Conversation
Up to standards ✅🟢 Issues
|
Contributor
There was a problem hiding this comment.
Pull request overview
Documentation-only refinements across several hardening script READMEs, adjusting warning tone, removing redundant notes, and renaming section headings for consistency.
Changes:
- Softens/relocates SSHD hardening warnings and removes a redundant prompt note.
- Renames "Installation Summary" → "Execution Summary" in Nginx WAF and UFW Cloudflare READMEs.
- Trims redundant safety notes in UFW Cloudflare and Root Locker READMEs.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Removes the top-level SSHD warning callout. |
| hardening/SSHD Hardening/README.md | Downgrades WARNING admonition to NOTE; drops the prompt-before-change line. |
| hardening/UFW Cloudflare/README.md | Renames heading; condenses Safety Notes. |
| hardening/Root Locker/README.md | Removes the SSH-config clarification bullet. |
| hardening/Nginx WAF/README.md | Renames heading to "Execution Summary". |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
This pull request primarily updates documentation for several hardening scripts, focusing on improving clarity, accuracy, and the tone of warnings and instructions. The most significant changes are the revision of warning notes, improved safety guidance, and clearer section headings.
Documentation and Safety Notes
README.mdandhardening/SSHD Hardening/README.mdto use a less alarming tone and provide more actionable safety guidance for users running SSHD hardening scripts. [1]], [2]])Section Headings and Structure