Skip to content

(docs) : Update README.md with corrections and comprehensive documentation improvements #439

@yuvraj-kolkar17

Description

@yuvraj-kolkar17

The current README.md has several issues that affect contributor experience:

Errors Found:

Typo: "How to contributing" → should be "How to contribute"
Grammar: "your PRs title" → should be "your PR's title"
Outdated Hugo version: References Hugo 0.57.2 from 2019 (current is 0.120+)
Missing content: No Windows installation guide, no troubleshooting section
Broken reference: "See the GitHub workflow" link is missing

Proposed Fix

Update README.md to include:
✅ Fix all spelling and grammar errors
✅ Remove outdated Hugo version numbers
✅ Add Windows installation instructions
✅ Add troubleshooting section
✅ Add project structure overview
✅ Add "Getting Help" section with community links
✅ Improve overall formatting and organization

Impact

Better contributor onboarding - clear, accurate setup instructions
Fewer support questions - comprehensive troubleshooting guide
Professional documentation - reflects project maturity

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions