feat: add project structure section to README

[Vaibhav-221]

✨ Feature Description

Add a well-structured Project Structure section to the README.md file.

Currently, the README provides project information, but it lacks a clear overview of the repository’s folder and file organization. A dedicated project structure section would help contributors understand the codebase faster and navigate important directories with ease.

🤔 Problem It Solves

New contributors often need time to understand where routes, components, APIs, modules, tests, configuration files, and templates are located.

This feature would help:

• New open-source contributors
• GSSoC participants
• Maintainers reviewing documentation
• Developers trying to understand the project architecture quickly

A documented file structure improves onboarding and makes the repository more contributor-friendly.

💡 Proposed Solution

Add the following Project Structure section to the README.md file:

Project Structure

Editron/
├── .github/                    # CI workflows, issue & PR templates
├── app/                        # Next.js App Router
│   ├── (auth)/                 # Authenticated route group
│   │   └── auth/
│   │       ├── components/     # Auth-specific UI components
│   │       ├── layout.tsx
│   │       └── sign-in/
│   │           └── page.tsx
│   ├── (root)/                 # Public route group
│   │   ├── docs/
│   │   │   ├── layout.tsx
│   │   │   └── page.tsx
│   │   ├── privacy/
│   │   │   └── page.tsx
│   │   ├── templates/
│   │   │   ├── layout.tsx
│   │   │   └── page.tsx
│   │   ├── terms/
│   │   │   └── page.tsx
│   │   ├── layout.tsx
│   │   └── page.tsx            # Home page
│   ├── api/
│   │   ├── auth/[...nextauth]/route.ts
│   │   ├── chat/
│   │   │   ├── route.ts        # Streaming AI chat endpoint
│   │   │   ├── tools.ts        # Tool definitions for AI
│   │   │   └── chat.test.ts
│   │   ├── collab-token/[id]/route.ts
│   │   ├── completion/route.ts # Code completion endpoint
│   │   ├── delete-account/route.ts
│   │   ├── deploy/
│   │   │   ├── cloudflare/route.ts
│   │   │   ├── netlify/route.ts
│   │   │   └── vercel/route.ts
│   │   ├── projects/[id]/download/route.ts
│   │   ├── template/[id]/route.ts
│   │   ├── templates/meta/route.ts
│   │   └── upload-zip/route.ts
│   ├── dashboard/
│   │   ├── layout.tsx
│   │   └── page.tsx
│   ├── playground/[id]/
│   │   └── page.tsx            # Main editor shell
│   ├── preview/
│   │   └── page.tsx            # Sandbox preview route
│   ├── error.tsx
│   ├── icon.tsx
│   ├── layout.tsx
│   └── page.tsx
├── components/
│   ├── marketing/              # Landing page components
│   │   ├── home-page-client.tsx
│   │   ├── template-card.tsx
│   │   └── template-grid.tsx
│   ├── providers/              # React context providers
│   │   ├── query-provider.tsx
│   │   └── theme-providers.tsx
│   └── ui/                     # shadcn/ui primitives and custom components
├── lib/
│   ├── constants/
│   │   ├── config.ts
│   │   ├── template-summaries.ts
│   │   └── templates.ts        # Starter template registry
│   ├── templates/
│   │   ├── actions.ts
│   │   ├── actions.test.ts
│   │   └── types.ts
│   ├── api-utils.ts            # HTTP client helpers
│   ├── collab-token.ts         # Collaboration token utilities
│   ├── db.ts                   # Prisma client singleton
│   ├── playground-auth.ts      # Playground access control
│   ├── template.ts             # Template mapping and processing
│   ├── user-data.ts            # User data helpers
│   ├── utils.ts                # General utilities
│   └── yjs.ts                  # Yjs document helpers
├── modules/
│   ├── auth/
│   │   ├── actions/
│   │   ├── components/
│   │   ├── hooks/
│   │   └── types.ts
│   ├── dashboard/
│   │   ├── actions/
│   │   ├── components/
│   │   └── types.ts
│   ├── home/                   # Home page sections and components
│   ├── playground/
│   │   ├── components/
│   │   ├── hooks/
│   │   └── lib/
│   │       ├── editor-config.ts
│   │       ├── index.ts
│   │       └── path-to-json.ts
│   ├── profile/
│   │   ├── actions.ts
│   │   ├── components/
│   │   └── data/
│   └── webcontainers/
│       ├── components/
│       └── hooks/
├── server/
│   └── collab.ts               # Standalone Yjs/WebSocket collaboration server
├── editron-starters/           # Bundled starter templates
│   ├── frontend/
│   ├── full-stack/
│   ├── backend/
│   └── tooling/
├── prisma/
│   └── schema.prisma
├── public/
├── tests/
│   ├── __mocks__/
│   ├── smoke/
│   ├── collab-token.test.ts
│   ├── env-manager.test.tsx
│   └── setup.ts
├── types/
│   ├── next-auth.d.ts
│   └── y-websocket.d.ts
├── .env.example
├── next.config.ts
└── package.json

This section can be placed after the setup instructions or before the contribution guidelines so contributors can easily find it.

🔄 Alternatives Considered

An alternative would be to create a separate ARCHITECTURE.md file for explaining the repository structure in more detail.

However, adding a concise project structure directly to the README is more accessible for new contributors because the README is usually the first file they read.

📸 Mockups / Examples

Not applicable, as this is a documentation improvement.

✅ Acceptance Criteria

• A new Project Structure section is added to README.md
• The section includes a clear folder tree of the repository
• Important folders and files include short descriptions
• The structure is formatted properly using a Markdown code block
• The README remains clean, readable, and beginner-friendly

📋 Additional Context

This improvement will make the repository easier to understand for first-time contributors and open-source participants, especially those contributing through GSSoC.

🌱 Contributor Checklist

• I am participating via GSSoC
• I have read the contribution guidelines
• I checked for existing issues before creating this

[github-actions]

👋 Thanks for opening an issue, @Vaibhav-221!

Our maintainers will review this issue shortly 🚀

---

📘 Before Contributing

Please read the contribution guide carefully before requesting assignment:

👉 https://github.com/piyushdotcomm/Editron/blob/main/CONTRIBUTING.md

---

🏷️ NSoC'26 / GSSoC'26 Requirement

Please clearly mention whether you are contributing via:

• NSoC'26
• GSSoC'26
• or as a regular contributor

Example: I am contributing under GSSoC'26

⚠️ Assignment requests without this information may be rejected automatically.

---

⏳ GSSoC Assignment Restriction

GSSoC contributors will only be allowed to take issue assignments after:

🗓️ May 15th, 12:00 AM IST

Before that date, assignment requests from GSSoC contributors will be automatically blocked.

---

🤖 Assignment System

To request assignment, comment: /assign or assign me

The smart assignment workflow validates:

• contributor eligibility
• NSoC/GSSoC participation mention
• active issue assignment limits
• repository contribution rules

---

⚠️ Important Repository Rules

• Do not start working before assignment
• Maximum 3 active assigned issues per contributor
• Contributors are encouraged to combine related fixes into 1–2 quality PRs instead of many small PRs
• PRs without assignment may be closed
• Spam or low-quality PRs may be rejected

Happy contributing 🎉

[Vaibhav-221]

I am contributing under GSSoC'26
/assign

[stevesagronegocios673-ux]

Quick README note after looking at the current README and this proposal: I would be careful not to add the full tree exactly as written. The README already has a useful “Architecture At A Glance” section, so a very deep tree would repeat that section while making the page harder to scan.

The strongest version of this addition would be a contributor route map, not a full filesystem dump. For Editron, the first-time contributor mostly needs to know five paths:

app/                 Next.js routes, API endpoints, layouts, and pages
modules/playground/  editor, file tree, AI chat, workspace behavior
modules/webcontainers/ browser runtime and project execution
lib/constants/templates.ts + editron-starters/ starter catalog and template mapping
server/collab.ts     standalone Yjs/WebSocket collaboration server

That is more useful than listing every nested route under app/api, because the README reader is probably asking “where should I start?” rather than “what is every file?”

I’d place it immediately after “Where New Contributors Usually Start,” or replace that section with a slightly richer version. The current README already points to app/playground/[id]/page.tsx, modules/playground/, modules/webcontainers/, app/api/chat/route.ts, and lib/template.ts; that is the right mental model. The new section should strengthen that, not create a second navigation system.

Suggested acceptance tweak:

• Keep the README structure concise: top-level folders plus 5–8 contributor-critical paths.
• Move the exhaustive tree to ARCHITECTURE.md if maintainers want it preserved.
• In the README, include “Start here if you want to work on…” bullets:
  • editor UI -> modules/playground/
  • starter templates -> editron-starters/, lib/constants/templates.ts
  • AI chat/completion -> app/api/chat/route.ts, app/api/completion/route.ts
  • auth/dashboard -> modules/auth/, modules/dashboard/
  • collaboration -> server/collab.ts, lib/yjs.ts

One small wording note: the proposed tree says .github/ # CI workflows, issue & PR templates, but the value for contributors is not the folder itself; it is “CI and contribution automation.” That phrasing matches the rest of this README better.

Want the fuller pass? I can send a tightened README contributor-map section + 5 concrete edits to keep the structure beginner-friendly without making the README too long.

[github-actions]

⚠️ Maintainer Ping Warning

Hi @stevesagronegocios673-ux,

Please avoid repeatedly pinging maintainers for assignment, review, or merge requests.

Reviews and assignments are handled in queue order. Excessive pinging may lead to spam labeling and restrictions.

Recommended wait times:

• Assignment: 12–24 hours
• Review: 24–72 hours

[piyushdotcomm]

@Vaibhav-221 assigned to you. dont forget to star the repo

[github-actions]

⚠️ Maintainer Ping Warning

Hi @Vaibhav-221,

Please avoid repeatedly pinging maintainers for assignment, review, or merge requests.

Reviews and assignments are handled in queue order. Excessive pinging may lead to spam labeling and restrictions.

Recommended wait times:

• Assignment: 12–24 hours
• Review: 24–72 hours