Improve Readme Formatting and Structure

[Dippp10-ally]

---

❓ Problem Statement

The current README file is not well-structured and lacks clarity in explaining the project. New users or contributors may find it difficult to understand what the project does, how to set it up, and how to contribute.

Key issues:

• Missing or unclear project overview
• Setup/installation steps are incomplete or not well organized
• Lack of usage instructions or examples
• Poor structure and formatting in sections
• No clear contribution guidelines or workflow explanation

---

💡 Proposed Solution

Improve the README by restructuring and adding clear documentation sections such as:

• Project overview and purpose
• Features list
• Installation and setup guide (step-by-step)
• Usage instructions with examples
• Folder/project structure explanation
• Contribution guidelines
• License information

---

🎯 Benefits

This improvement would:

• Make onboarding easier for new contributors
• Improve project clarity and professionalism
• Reduce confusion during setup and usage
• Encourage more open-source contributions
• Provide better documentation standards

---

🔄 Alternatives Considered

• Keeping README minimal and adding external documentation wiki
• Adding inline comments in code instead of documentation
• Using auto-generated documentation tools

---

🛠️ Possible Implementation

• Rewrite README using a structured Markdown format
• Add badges (build status, license, etc.)
• Include screenshots or demo GIFs
• Add clear step-by-step setup instructions
• Provide example usage commands or snippets
• Link contributing guidelines and issue templates

---

📌 Additional Context

A well-structured README is critical for improving developer experience and ensuring the project is easy to understand, use, and contribute to.

---

[Dippp10-ally]

@madanrajsagar ji , do assign above issue number 141 to me also.....do assign labels called as gssoc:approved , level:intermediate , type:docs , quality:exceptional to above issue number 141 also...

[sanicadhawan]

Hi @madanrajsagar,

I would like to work on this issue under GSSoC 2026. The README improvement task aligns with my skills, and I can restructure the documentation by adding a clear project overview, setup guide, usage instructions, contribution guidelines, and better formatting.

Could you please assign this issue to me?

Thank you!

[bhushan4work]

dear @madanrajsagar , could u please assign thiss issue to me, I m a contributor under gssoc 26 . thank u

[sapnajha757]

Hi @madanrajsagar ,

I would like to work on this issue and would appreciate it if you could assign it to me.

My Approach

I plan to improve the README by restructuring it into a clear and beginner-friendly format. The changes will include:

• Adding a concise project overview explaining the purpose and objectives of the project.
• Creating a well-organized features section highlighting key functionalities.
• Providing detailed installation and setup instructions with step-by-step guidance.
• Adding usage examples to help users understand how to run and interact with the project.
• Including a project structure section to explain the folder organization.
• Adding contribution guidelines covering the workflow for contributors.
• Including license information and relevant project resources.
• Improving overall formatting, readability, and navigation using proper Markdown headings, lists, badges, and links.
• Adding screenshots or demo GIFs (if applicable) to enhance documentation.

Expected Outcome

This will make the project more accessible to new users and contributors, improve onboarding, and provide a more professional and maintainable documentation standard.

Looking forward to contributing to this project. Thank you!

[Archana7224]

Hi @madanrajsagar 👋

I would like to work on this issue under GSSoC 2026.

After reviewing the current README and the issue requirements, I believe the documentation can be significantly improved to provide a better onboarding experience for both users and contributors. I have experience working with full-stack projects and open-source documentation, and I would like to contribute a comprehensive README overhaul rather than just a formatting update.

Proposed Deliverables

📌 Project Introduction & Overview

• Clear explanation of the project's purpose and goals.
• Problem statement and use cases.
• Target audience and key benefits.

✨ Features Section

• Well-organized feature list.
• Highlight core functionalities and project capabilities.
• Add feature categorization where appropriate.

🛠️ Installation & Setup Guide

• Step-by-step setup instructions from a fresh clone.
• Dependency installation commands.
• Environment variable configuration.
• Local development setup.

🚀 Usage Guide

• How to run the project.
• Example commands and workflows.
• Screenshots or GIF demonstrations (if applicable).

📂 Project Structure

• Explain the folder hierarchy.
• Brief description of important directories and files.
• Help contributors understand the codebase faster.

🤝 Contribution Guidelines

• Fork → Branch → Commit → PR workflow.
• Coding standards and contribution expectations.
• Guidance for new contributors.

📖 Documentation Improvements

• Add a Table of Contents for easier navigation.
• Improve Markdown formatting and readability.
• Add badges (license, build status, etc.) where applicable.
• Add troubleshooting and FAQ sections if relevant.

⚖️ License & Resources

• Clearly document licensing information.
• Link relevant resources, issue templates, and contribution documents.

Validation Process

Before submitting the PR, I will verify that:

• A new contributor can follow the setup instructions successfully.
• All commands and links are accurate.
• The README remains concise, structured, and beginner-friendly.
• Documentation aligns with project standards and improves overall developer experience.

Estimated Timeline

• Repository analysis and documentation audit: 2–3 hours
• README restructuring and content drafting: 4–5 hours
• Screenshots/examples and contributor documentation: 2–3 hours
• Final review, formatting, and validation: 1–2 hours

Expected completion: Within 1–2 days of assignment.

I am confident I can deliver a professional, well-structured README that improves project clarity, onboarding, and contributor engagement.

Could you please assign this issue to me?

Thank you for your consideration!

[asiyasafwana15-byte]

Hi @madanrajsagar plz assign this issue to me.

[shikha123-ops]

Hi @madanrajsagar 👋

I would like to work on this issue.

I plan to improve the README by restructuring the documentation, adding a clear project overview, installation and setup instructions, usage examples, contribution guidelines, and other relevant sections to enhance readability and developer onboarding.

Could you please assign this issue to me? Thank you!

[pakhijain22]

@madanrajsagar
Please assign this issue to me
Thank You !!

[anmolsingh941513]

Hi @madanrajsagar 👋 I'm a GSSoC '26 contributor and I'd love to work on this!

I can restructure the README with a clear project overview, step-by-step setup guide, usage instructions with examples, folder structure explanation, contribution guidelines, and license info — all in clean structured Markdown with badges.

Could you please assign this issue to me? I'll have a PR ready soon!

[lightningMcQueen9595]

Hi @maintainers,

I would like to work on this issue under GSSoC. Kindly assign it to me.

Thank you.

[yatridave]

I would love to work on this, please assign it to me.

[Heemadhawala-R]

Hello @madanrajsagar ,

I hope you're doing well. I'm interested in contributing to this project as part of GSSoC. Could you please assign me this issue? I would love to work on it and will ensure I follow the project's contribution guidelines.

Thank you!

[hemag111]

Hi @madanrajsagar

I would love to work on this issue under GSSoC 2026. Improving the README is an excellent way to enhance the project's accessibility and onboarding experience for new contributors.

My Proposed Plan:

• Table of Contents: Add a clean navigation structure at the top for easy browsing.
• Project Overview & Features: Draft a concise introduction explaining the purpose of Abhaya alongside a bulleted list of core features.
• Prerequisites & Installation: Provide clear, step-by-step setup instructions from a fresh clone, including commands for dependency installation.
• Usage & Examples: Include sample commands or snippets to show how to run and interact with the project locally.
• Directory Structure: Add a visual tree layout explaining the key folders to help new developers navigate the codebase faster.
• Contribution Guidelines: Provide a quick outline of the Fork ➡️ Branch ➡️ PR workflow and mention where to find issue templates.
• Badges & Formatting: Professionalize the layout using markdown badges (License, PRs Welcome, etc.) and structured headings.

Could you please assign this issue to me? I can get started right away and submit a well-verified PR soon.

Thank you!