Enhance README.md documentation and structure #25
Conversation
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
This commit significantly improves the README.md by:
- Adding a "What is DevSecOps and Why is it Important?" section to provide context for you.
- Introducing a "How to Use This Roadmap" section to guide you through the content.
- Improving the "Tools" section by replacing a direct file link with a more descriptive summary and a user-friendly link.
- Correcting image paths in the "Other roadmaps" section to be relative and ensuring the Gitlab diagram is a clickable link to a relevant page.
- Performing a general review for grammar, typos, and flow, which included:
- Removing redundant text in the "Tools" section.
- Correcting typos (e.g., "Developerment" to "Development", "pdiscoveryio" to "projectdiscovery", "Securit-Testing" to "Security-Testing").
- Removing a redundant "Security Patch" subsection.
- Adjusting heading level for "Awesome Resources" for better hierarchy.
- Fixing minor formatting issues (e.g., spacing, image path for CONTRIBUTORS.svg).
These changes aim to make the DevSecOps roadmap more accessible, informative, and user-friendly.
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the README.md documentation by adding contextual sections, improving structure, fixing typos, and updating links and image paths.
- Added a “What is DevSecOps and Why is it Important?” section and a “How to Use This Roadmap” guide.
- Replaced a raw tools file link with a descriptive summary and user-friendly link.
- Corrected typos (“Developerment” → “Development”, “pdiscoveryio” → “projectdiscovery”, “Securit-Testing” → “Security-Testing”) and fixed relative image paths and external links.
Comments suppressed due to low confidence (1)
README.md:22
- Table of Contents should include entries for the newly added 'What is DevSecOps and Why is it Important?' and 'How to Use This Roadmap' sections to help navigation.
- [Roadmap](#-roadmap)
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
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 commit significantly improves the README.md by:
These changes aim to make the DevSecOps roadmap more accessible, informative, and user-friendly.