Skip to content

docs: enhance README formatting and remove duplicate sections#73

Open
Rudra-repo wants to merge 1 commit into
AditixAnand:mainfrom
Rudra-repo:docs/enhance-readme
Open

docs: enhance README formatting and remove duplicate sections#73
Rudra-repo wants to merge 1 commit into
AditixAnand:mainfrom
Rudra-repo:docs/enhance-readme

Conversation

@Rudra-repo
Copy link
Copy Markdown

@Rudra-repo Rudra-repo commented May 19, 2026

Summary

Ref #1

Enhances the README.md by improving formatting, fixing minor grammar issues, and ensuring consistent headings throughout the document.

Changes

  • Removed all duplicate sections — Folder Structure, Setup Instructions, Contribution Guidelines, Issue Management, Pull Request Rules, Future Enhancements, and Contact were each listed twice
  • Consolidated folder structure into a single fenced code block; added missing files (admin.html, package.json, package-lock.json)
  • Unified setup sub-steps with consistent ### headings instead of mixed emoji-numbered and ### styles
  • Fixed grammar: added periods to list items, capitalised "Project Admin" consistently, used uniform dash style in tech list
  • Moved virtual-env tip into a blockquote callout for better visibility
  • Presented issue labels as a readable table instead of a plain list
  • Linked LICENSE file and formatted LinkedIn as a clickable link
  • Removed stray double horizontal rules and trailing whitespace

- Remove all duplicate sections (Folder Structure, Setup Instructions,
  Contribution Guidelines, Issue Management, Pull Request Rules,
  Future Enhancements, and Contact were each listed twice)
- Consolidate folder structure into a single fenced code block and
  add missing files (admin.html, package.json, package-lock.json)
- Unify setup sub-steps as consistent ### headings instead of mixed
  emoji-numbered and ### styles
- Fix grammar: add periods to list items, capitalise 'Project Admin'
  consistently, use uniform dash style in tech list
- Move virtual-env tip into a blockquote callout for better visibility
- Present issue labels as a table for improved readability
- Link LICENSE file and format LinkedIn as a clickable link
- Remove stray double horizontal rules and trailing whitespace
@Rudra-repo Rudra-repo closed this May 19, 2026
@Rudra-repo Rudra-repo deleted the docs/enhance-readme branch May 19, 2026 09:05
@Rudra-repo Rudra-repo restored the docs/enhance-readme branch May 19, 2026 09:05
@Rudra-repo Rudra-repo reopened this May 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant