docs: clarify Common-UI role in codebase structure

[ShivaniSharma14]

Summary

This PR clarifies the role of Common-UI in the AMRIT codebase structure for first-time contributors.

Why

The current docs list the repositories, but new contributors may still be unsure whether Common-UI should be treated like a standalone UI app or as shared infrastructure used by multiple UI modules.

Related

Related to PSMRI/AMRIT#111

Summary by CodeRabbit

• Documentation
  • Updated developer guide with clarified guidance on shared component dependencies and setup requirements for contributors.

[coderabbitai]

📝 Walkthrough

Walkthrough

Documentation update adding guidance for contributors regarding Common-UI as a shared dependency managed via Git submodule, instructing first-time contributors to check UI repositories for shared component dependencies before beginning local development work.

Changes

Cohort / File(s)	Summary
Documentation developer-guide/codebase-structure.md	Added clarification under "Shared Components" that Common-UI is a shared dependency via Git submodule and advises contributors to verify shared component dependencies in UI repositories before starting local work.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰✨ A guide so clear, now fresh and bright,
Git submodules and shared repos in sight,
First-time friends will know the way,
Check the Common-UI before you play! 🌟

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely summarizes the main change—adding documentation to clarify Common-UI's role in the codebase structure, which directly matches the PR's objective and the documentation update made.
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.}

[coderabbitai]

🧹 Nitpick comments (1)

developer-guide/codebase-structure.md (1)

121-121: Documentation addition is clear and helpful.

The explanation effectively clarifies Common-UI's role as shared infrastructure and provides valuable guidance for first-time contributors. The distinction between "shared infrastructure" and "standalone product application" directly addresses the confusion mentioned in issue #111.

However, consider these optional improvements for better readability and actionability:

📚 Optional refinements for improved clarity

Option 1: Break into sub-bullets for better scannability

-  * **Common-UI note for first-time contributors**: Common-UI is a shared dependency used by many AMRIT UI products and is commonly added as a Git submodule. It should be treated as shared infrastructure rather than as a standalone product application. Before starting a UI repository locally, check whether it depends on Common-UI or other shared components.
+  * **Common-UI note for first-time contributors**: 
+    * Common-UI is a shared dependency used by many AMRIT UI products and is commonly added as a Git submodule.
+    * It should be treated as shared infrastructure rather than as a standalone product application.
+    * Before starting a UI repository locally, check whether it depends on Common-UI or other shared components (look for a `.gitmodules` file in the repository root).

Option 2: Add actionable guidance on checking for dependencies

-  * **Common-UI note for first-time contributors**: Common-UI is a shared dependency used by many AMRIT UI products and is commonly added as a Git submodule. It should be treated as shared infrastructure rather than as a standalone product application. Before starting a UI repository locally, check whether it depends on Common-UI or other shared components.
+  * **Common-UI note for first-time contributors**: Common-UI is a shared dependency used by many AMRIT UI products and is commonly added as a Git submodule. It should be treated as shared infrastructure rather than as a standalone product application. Before starting a UI repository locally, check whether it depends on Common-UI or other shared components by reviewing the `.gitmodules` file or the repository's README for setup instructions.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@developer-guide/codebase-structure.md` at line 121, Split the single-line
"Common-UI note for first-time contributors" into a short bullet with two
sub-bullets (1) describe that Common-UI is a shared Git submodule used across
AMRIT UIs and (2) treat it as shared infrastructure not a standalone app; then
add a concise actionable "How to check" sub-bullet listing concrete checks
contributors can run to detect the dependency (inspect git submodules, review
package.json/deps, and check the repo README/CONTRIBUTING for references to
Common-UI). Ensure the updated text replaces the existing sentence and keeps the
same wording intent ("check whether it depends on Common-UI or other shared
components") while improving scannability via bullets and a short checklist.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@developer-guide/codebase-structure.md`:
- Line 121: Split the single-line "Common-UI note for first-time contributors"
into a short bullet with two sub-bullets (1) describe that Common-UI is a shared
Git submodule used across AMRIT UIs and (2) treat it as shared infrastructure
not a standalone app; then add a concise actionable "How to check" sub-bullet
listing concrete checks contributors can run to detect the dependency (inspect
git submodules, review package.json/deps, and check the repo README/CONTRIBUTING
for references to Common-UI). Ensure the updated text replaces the existing
sentence and keeps the same wording intent ("check whether it depends on
Common-UI or other shared components") while improving scannability via bullets
and a short checklist.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: e105b10b-38a8-4ba3-ba07-b691f95d1f49

📥 Commits

Reviewing files that changed from the base of the PR and between a71af10 and cb39529.

📒 Files selected for processing (1)

• developer-guide/codebase-structure.md