docs: enhance CONTRIBUTING.md and README.md with comprehensive improvements
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.
Deploy Preview for bejewelled-pegasus-b0ce81 ready!
| Name | Link |
|---|---|
| Latest commit | 2d2a2432aa9ecf50924ea3daf9174453eb15099c |
| Latest deploy log | https://app.netlify.com/projects/bejewelled-pegasus-b0ce81/deploys/68f215dd91cbd5000857338c |
| Deploy Preview | https://deploy-preview-839--bejewelled-pegasus-b0ce81.netlify.app |
| Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify project configuration.
@Vincamine review, please.
Thank you for your contribution! Let's discuss this during the website call today at 5:30 PM IST | 7 AM CT Add it as an agenda item to the meeting minutes, if you would 😄
Hey @Ansita20 DCO Failed ⚠️ To add your Signed-off-by line to every commit in this branch:
- Ensure you have a local copy of your branch by checking out the pull request locally via command line.
- In your local branch, run:
git rebase HEAD~2 --signoff - Force push your changes to overwrite the branch:
git push --force-with-lease origin improvedDOC
Thank you for your contribution! Let’s discuss this during the website call tomorrow (November 3) at 5:30 PM IST | 7:00 AM CT. Please add it as an agenda item to the meeting minutes 😊
Checking in... it has been awhile since we've heard from you on this issue. Are you still working on it? Please let us know and please don't hesitate to contact a MeshMate or any other community member for assistance.
Be sure to join the community, if you haven't yet and please leave a :star: star on the project :smile:
@Ansita20 Thank you for your contribution! Let's discuss this during the website call today at 6:30 PM IST | 8 AM CT Add it as an agenda item to the meeting minutes, if you would :)
No response from PR author.