Add Collapsible Project Structure Section to README

[Vaibhav-221]

🔗 Related Issue

Closes #454

📝 Description

This PR enhances the project documentation by adding a Project Structure section to the README.md.

To prevent the README from becoming excessively long while still providing contributors with a complete overview of the repository architecture, the project structure has been placed inside a collapsible <details> block with a <summary> header.

This approach keeps the README clean and beginner-friendly while allowing contributors to easily access the full repository structure when needed.

---

✨ Changes Made

• Added a new Project Structure section to README.md
• Included a detailed repository folder tree with descriptions
• Wrapped the complete structure inside a collapsible <details> block
• Added a clickable <summary> section for improved readability
• Maintained proper GitHub Flavored Markdown (GFM) formatting
• Improved onboarding experience for contributors and GSSoC participants

---

📂 Implementation

The structure is displayed using a collapsible section:

<details>
<summary>📂 View Complete Project Structure</summary>

...complete repository structure...

</details>

This ensures that:

• The README remains concise and easy to navigate
• Large documentation blocks do not overwhelm readers
• Contributors can expand the section only when needed

---

🎯 Benefits

• Faster onboarding for new contributors
• Better understanding of repository architecture
• Improved navigation of project directories
• Cleaner and more organized README
• Enhanced contributor experience for GSSoC and open-source participants

---

🧪 Testing

• Verified that the <details> and <summary> tags render correctly on GitHub
• Confirmed that the project structure expands and collapses as expected
• Checked Markdown formatting and code block rendering
• Ensured README readability remains intact

---

📸 Screen Recording

Screen.Recording.2026-06-04.011922.mp4

---

✅ Checklist

• Added Project Structure section
• Used collapsible <details> block for better readability
• Included descriptions for important folders and files
• Verified GitHub Markdown rendering
• No source code changes introduced
• Documentation remains clean and contributor-friendly

---

📋 Additional Notes

This is a documentation-only enhancement intended to improve repository discoverability and contributor onboarding without affecting any existing functionality.

Summary by CodeRabbit

• Documentation
  • Updated README with improved contributor-friendly documentation and automation notes
  • Added comprehensive Project Structure section with expanded directory tree overview
  • Added route map checklist highlighting key folders and files for core development areas including editors, templates, chat, auth, and collaboration features

[qodo-code-review]

Qodo reviews are paused for this user.

Troubleshooting steps vary by plan Learn more →

On a Teams plan?
Reviews resume once this user has a paid seat and their Git account is linked in Qodo.
Link Git account →

Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center?
These require an Enterprise plan - Contact us
Contact us →

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 431c2657-821b-466d-8032-502d238c75a0

📥 Commits

Reviewing files that changed from the base of the PR and between f12b223 and 15505d0.

📒 Files selected for processing (1)

• README.md

---

Walkthrough

This PR updates the README.md with improvements to contributor documentation. It rewords the maintenance note, introduces a new Project Structure section with a detailed directory tree, and replaces generic guidance with a route map checklist to help new contributors navigate key repository areas.

Changes

README Contributor Documentation

Layer / File(s)

Summary

README sections: maintenance note, project structure, and contributor route map README.md

Reworded the maintenance/contributor-workflow note to emphasize contributor-friendly documentation and automation. Added a new collapsible "Project Structure" section documenting the repository's directory tree, including Next.js app structure, modules, lib, server, starters, Prisma, tests, and config. Replaced the generic "Good first areas to understand" section with a route map checklist pointing new contributors to editor UI, starter templates, AI chat/completion, auth/dashboard flows, and collaboration features.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐰 A README refreshed with structure so clear,
New paths light the way, no confusion to fear,
From root down to modules, each folder's a friend,
Contributors onboard—the journey won't end! ✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately summarizes the main change: adding a collapsible Project Structure section to the README.
Description check	✅ Passed	The description is comprehensive and covers changes, motivations, implementation details, and testing. However, it deviates from the provided template structure.
Linked Issues check	✅ Passed	The PR successfully implements issue #454 requirements: added Project Structure section with folder tree, descriptions, proper formatting, improved onboarding, and maintained README readability.
Out of Scope Changes check	✅ Passed	All changes are scoped to the linked issue #454. The README updates directly address project structure documentation without introducing unrelated modifications.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[github-actions]

👋 Thanks for opening a PR, @Vaibhav-221!

Your PR has entered the 🚦 PR Review Pipeline.

🟢 GSSOC PR detected — your PR will be routed to an approved GSSOC mentor for Stage 2 review.

---

What happens next

Stage	Reviewer	Checks
Stage 1 — Automated Validation	🤖 Bot	DCO · Format · AI/Slop · Duplicate
Stage 2 — Human Review	🧑‍🏫 GSSOC Mentor	Code + Quality Review
Stage 3 — PA / Maintainer Review	🔑 Project Admin	Final Merge Decision

A pipeline status comment will appear below and update automatically as your PR progresses.

---

While you wait

• Sign all commits (git commit -s)
• Link your issue (Closes #123)
• Use a feature branch (not main)
• Avoid unrelated changes

This comment is posted only once.

[Vaibhav-221]

@piyushdotcomm, review the PR.