Skip to content

Revise README for clarity and additional information#156

Closed
HafshaMimJannatee wants to merge 1 commit into
sunnah-com:masterfrom
HafshaMimJannatee:master
Closed

Revise README for clarity and additional information#156
HafshaMimJannatee wants to merge 1 commit into
sunnah-com:masterfrom
HafshaMimJannatee:master

Conversation

@HafshaMimJannatee

@HafshaMimJannatee HafshaMimJannatee commented Feb 14, 2026

Copy link
Copy Markdown

Updated README to enhance project details and instructions.

Summary

This PR improves the README documentation for the Sunnah.com frontend repository to make it clearer and more contributor-friendly.

Fixes #157

What was changed

  • Reorganized the README with clearer sections and headings
  • Added a short project introduction and structure overview
  • Improved readability and formatting
  • Clarified local setup steps and dev container usage
  • Added a contribution guidance section

Why this change

The previous README contained useful information but was difficult to scan for new contributors.
This update focuses on clarity, structure, and ease of understanding without changing any application code.

Scope

  • Documentation only
  • No functional or behavioral changes

Please let me know if you would like any section adjusted or simplified further.

Updated README to enhance project details and instructions.
@hasankhan

Copy link
Copy Markdown
Collaborator

Closing as a duplicate of #163, which restructures the README with the same goals (clearer sections, contributor-friendly structure) and additionally adds a Table of Contents with verified anchors, a project-structure table, a Sample Database section describing db/, a Code Style subsection pointing at php-cs-fixer, a Content Corrections subsection, and a License section. Thanks for the contribution — please feel free to review or build on top of #163.

@hasankhan hasankhan closed this May 31, 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.

Improve README structure and contributor guidance

2 participants