docs: enhance CONTRIBUTING.md and README.md with comprehensive improvements #839
+488
−262
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
✅ Deploy Preview for bejewelled-pegasus-b0ce81 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
leecalcote
requested changes
Oct 16, 2025
CONTRIBUTING.md
Outdated
|
|
||
| ## <a name="contributing-docs">Documentation Contribution Flow</a> | ||
| Please contribute! Layer5 documentation uses Jekyll and GitHub Pages to host docs sites. Learn more about [Layer5's documentation framework](https://docs.google.com/document/d/17guuaxb0xsfutBCzyj2CT6OZiFnMu9w4PzoILXhRXSo/edit?usp=sharing). The process of contributing follows this flow: | ||
| Improve the contributing documentation to be more professional, |
There was a problem hiding this comment.
These aren't the intended changes, but notes from your AI session. Please retry, @Ansita20.
There was a problem hiding this comment.
Make sure to sign-off on your commits, too. See the doc that you are conceptually improving for instructions, @Ansita20
There was a problem hiding this comment.
Sir, Sorry for the previous carelessness. I have fixed the mistake I made. Can you please check the changes.
Signed-off-by: Ansita-1 <ansita6050@gmail.com>
|
@Vincamine review, please. |
|
Thank you for your contribution! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Notes for Reviewers
This PR fixes #835
CONTRIBUTING.md
Errors Fixed:
❌ Missing prerequisites context and version requirements
❌ No step-by-step setup instructions
❌ Incomplete contribution workflow and PR guidelines
❌ Missing style guidelines and commit message conventions
Improvements: Added table of contents, detailed setup guide, git workflow with commands, PR best practices, and community support section.
README.md
Errors Fixed:
❌ No table of contents or navigation
❌ Missing visual preview of documentation site
❌ Incomplete contributing guidelines (no image/alert examples)
❌ Minimal community engagement information
Improvements: Added TOC, documentation GIF preview, target audience matrix, detailed setup instructions, collapsible documentation structure sections, image/alert syntax examples with tables, expanded community resources, and professional footer.
Total Impact: Both files transformed from basic docs to comprehensive, professional guides with better navigation, practical examples, and complete information for all user types.