docs icon indicating copy to clipboard operation
docs copied to clipboard

docs: enhance CONTRIBUTING.md and README.md with comprehensive improvements

Open Ansita20 opened this issue 2 months ago • 5 comments

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.

Ansita20 avatar Oct 15 '25 22:10 Ansita20

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...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

netlify[bot] avatar Oct 15 '25 22:10 netlify[bot]

@Vincamine review, please.

leecalcote avatar Oct 24 '25 19:10 leecalcote

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 😄

Rajesh-Nagarajan-11 avatar Oct 27 '25 11:10 Rajesh-Nagarajan-11

Hey @Ansita20 DCO Failed ⚠️ To add your Signed-off-by line to every commit in this branch:

  1. Ensure you have a local copy of your branch by checking out the pull request locally via command line.
  2. In your local branch, run: git rebase HEAD~2 --signoff
  3. Force push your changes to overwrite the branch: git push --force-with-lease origin improvedDOC

Rajesh-Nagarajan-11 avatar Oct 31 '25 04:10 Rajesh-Nagarajan-11

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 😊

Rajesh-Nagarajan-11 avatar Nov 02 '25 13:11 Rajesh-Nagarajan-11

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:

github-actions[bot] avatar Dec 01 '25 07:12 github-actions[bot]

@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 :)

kishore08-07 avatar Dec 01 '25 08:12 kishore08-07

No response from PR author.

simihablo avatar Dec 04 '25 05:12 simihablo