Update README.md

[farah21109]

Related Issue(s)

Fixes #5

##Summary##

The README currently lacked a clear explanation of the project’s folder structure. This PR adds a detailed project structure section with descriptions for all main folders and files, making it easier for new contributors to understand the codebase and navigate the project.

##Changes##

Added a Project Structure section to the README.
Included descriptions for key folders and files: .github, api, docs, engine, and root files.
Structured the documentation so it is clear, readable, and beginner-friendly.

##How to Test##

Open the updated README.md.
Verify that the Project Structure section is present and matches the actual repo layout.
Ensure that all descriptions are accurate and readable.

Note: Please ensure that appropriate labels (like gssoc25 and level labels) are assigned to the merged PR.

Summary by CodeRabbit

• Documentation
  • Added a "Project Structure" section with an ASCII-style repository map showing top-level folders and common files.
  • Inserted between the Architecture and Quick Start sections for easier orientation.
  • Helps newcomers discover project layout and improves navigation.
  • Documentation-only change; no functional or runtime impact.

[coderabbitai]

Walkthrough

README.md updated to add a new "Project Structure" section containing an ASCII map of the repository layout; the section is placed after Architecture and before Quick Start. This is a documentation-only change with no code, runtime, or public API modifications.

Changes

Cohort / File(s)	Summary of Changes
Documentation README.md	Added a "Project Structure" section with an ASCII map of the repository layout; inserted after Architecture and before Quick Start; documentation-only change.

Pre-merge checks

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The PR title "Update README.md" directly references the file changed and corresponds to the main change (adding a Project Structure section to the README), so it is concise and related to the changeset, though it is somewhat generic and could be more descriptive.
Linked Issues Check	✅ Passed	The PR implements a "Project Structure" section in README.md with a tree-like ASCII map and descriptions for .github, api, docs, engine, and root files, which satisfies the linked issue's requirements to add folder hierarchy and guidance for contributors (Issue #5 [#5]); the changes are documentation-only and align with the stated objectives.
Out of Scope Changes Check	✅ Passed	All modifications are limited to README.md (documentation only) and the raw summary notes no changes to exported/public declarations or other code files, so there are no out-of-scope or unrelated code changes in this PR.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

• Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
• Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

---

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.}

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

README.md (1)

91-91: Add a language to the fenced code block to satisfy markdownlint (MD040).

Specify the fence as "text" (or "plaintext") so linters don’t warn and GitHub renders appropriately.

-```
+```text

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fa86ac4 and 420f62b.

📒 Files selected for processing (1)

• README.md (2 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.17.2)

README.md

91-91: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🔇 Additional comments (2)

README.md (2)

90-125: Nice addition — clear, beginner-friendly structure.

The emojis and concise folder comments improve scannability.

---

90-125: Add top-level ui/ or update README's Architecture section

README.md (lines 90–125) references a top-level ui service but the repository has no ui/ directory; the verification script reported no other missing top-level entries. Either add the ui/ service or remove/update that entry in README.md.

[coderabbitai]

Actionable comments posted: 0

♻️ Duplicate comments (1)

README.md (1)

92-92: Root label fixed — looks correct now.

Tree root shows "📦 DialogWeaver" (matches repo). Good catch and fix.

🧹 Nitpick comments (2)

README.md (2)

91-91: Add a language to the fenced code block (markdownlint MD040).

Specify a language for the project tree block to satisfy linters and improve rendering.

-```
+```text

---

90-125: Optional: Add quick links below the tree.

Add short bullet links to frequently used files (e.g., api/main.py, engine/main.py, docker-compose.yml) right under the code block for faster navigation.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 420f62b and ee6bdbf.

📒 Files selected for processing (1)

• README.md (2 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.17.2)

README.md

91-91: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🔇 Additional comments (1)

README.md (1)

97-117: Directory tree verified — all listed paths exist.
Requested paths (including api/*, engine/openvoiceos_engine, engine/telephony_server, and docs assets) are present.