Skip to content

docs: add AMRIT ecosystem architecture documentation and Mermaid diagram#160

Open
charantejguniganti wants to merge 2 commits into
PSMRI:mainfrom
charantejguniganti:feature/ecosystem-architecture
Open

docs: add AMRIT ecosystem architecture documentation and Mermaid diagram#160
charantejguniganti wants to merge 2 commits into
PSMRI:mainfrom
charantejguniganti:feature/ecosystem-architecture

Conversation

@charantejguniganti
Copy link
Copy Markdown

@charantejguniganti charantejguniganti commented May 12, 2026

📝 Description

JIRA ID: N/A

This PR introduces docs/ARCHITECTURE.md — a high-level overview of the AMRIT ecosystem designed to help contributors understand how the system fits together before diving into any individual repository.

The document maps relationships across AMRIT UI repositories, API microservices, mobile applications, and infrastructure components using a Mermaid.js architecture diagram. For a multi-repository ecosystem like AMRIT, this kind of bird's-eye view is often the missing piece for new contributors trying to orient themselves quickly.

Changes Added:

  • Added docs/ARCHITECTURE.md with full ecosystem overview
  • Added Mermaid.js architecture diagram covering all major layers
  • Documented UI, API, Mobile, and Infrastructure components and their relationships
  • Added architecture reference link inside README.md
  • Improved repository discoverability and contributor onboarding experience

✅ Type of Change

  • 📘 Documentation (updates to docs or readme)
  • New feature (non-breaking change which adds functionality)

ℹ️ Additional Information

Motivation:
The AMRIT ecosystem spans multiple repositories and interconnected services, which can be difficult for new contributors to navigate without prior context. This documentation addresses that gap by clearly surfacing repository relationships, service interactions, system layering, and the overall ecosystem structure — making onboarding faster and reducing the ramp-up friction for first-time contributors.

Testing Performed:

  • Verified Mermaid.js diagram renders correctly on GitHub
  • Verified markdown formatting and document structure
  • Verified README reference link navigates correctly
  • Checked readability and accuracy of architecture descriptions

Screenshots: Included demonstrating rendered Mermaid.js diagram, architecture document layout, and README integration.

Added a high-level architecture document and Mermaid ecosystem diagram to help contributors better understand the repository structure and service relationships across AMRIT.

image

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 12, 2026

Warning

Rate limit exceeded

@charantejguniganti has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 45 minutes and 26 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 1d6d8f45-e490-41a1-9860-6fa804cf9119

📥 Commits

Reviewing files that changed from the base of the PR and between 4f3a2f6 and d4b364a.

📒 Files selected for processing (2)
  • README.md
  • docs/ARCHITECTURE.md
✨ 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 and usage tips.

@charantejguniganti
Copy link
Copy Markdown
Author

@drtechie
Added a high-level AMRIT ecosystem architecture document along with a Mermaid.js diagram to improve contributor onboarding and repository discoverability across the platform.

Would appreciate your review and feedback. Thanks!

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant