Skip to content

docs: append quick-reference directory map to ARCHITECTURE.md - #3243

Open
Rish-2006 wants to merge 1 commit into
Karanjot786:mainfrom
Rish-2006:docs/add-architecture-map
Open

docs: append quick-reference directory map to ARCHITECTURE.md#3243
Rish-2006 wants to merge 1 commit into
Karanjot786:mainfrom
Rish-2006:docs/add-architecture-map

Conversation

@Rish-2006

@Rish-2006 Rish-2006 commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Description

Appends a concise, high-level directory reference summary map section to the architecture document to assist incoming contributors with rapid workspace navigation.

Related Issue

Closes #3242

Which package(s)?

docs

Summary by CodeRabbit

  • Documentation
    • Added a quick directory map to the architecture documentation, clarifying the responsibilities of key workspace packages.

@Rish-2006
Rish-2006 requested a review from Karanjot786 as a code owner July 28, 2026 15:41
@github-actions github-actions Bot added the type:docs +5 pts. Documentation. label Jul 28, 2026
@coderabbitai

coderabbitai Bot commented Jul 28, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: e1dc4a05-1cb9-45df-a8c6-bd297f3d3228

📥 Commits

Reviewing files that changed from the base of the PR and between 48f63a1 and 7a13f46.

📒 Files selected for processing (1)
  • ARCHITECTURE.md

📝 Walkthrough

Walkthrough

ARCHITECTURE.md adds a “Quick Directory Map” section linking major responsibilities to key packages/* directories.

Changes

Architecture documentation

Layer / File(s) Summary
Quick directory map
ARCHITECTURE.md
Adds package directory mappings for the core engine, widgets, UI controls, JSX runtime/hooks, and headless testing renderer.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: karanjot786

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description includes the summary, issue, and package, but omits required sections like Type of Change and Checklist. Add the missing template sections, especially Type of Change, Checklist, GSSoC Participation, and Notes for the Reviewer.
Linked Issues check ❓ Inconclusive The summary matches the layout guide request, but it doesn't confirm the required agent section. Clarify whether the ARCHITECTURE.md map includes agents and helper testing folders, or share the full diff for verification.
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise, specific, and accurately describes the documentation update.
Out of Scope Changes check ✅ Passed Only ARCHITECTURE.md documentation was updated, matching the stated docs-only scope.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ 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

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type:docs +5 pts. Documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: create ARCHITECTURE.md directory layout overview

1 participant