docs: add AMRIT ecosystem architecture documentation and Mermaid diagram#160
docs: add AMRIT ecosystem architecture documentation and Mermaid diagram#160charantejguniganti wants to merge 2 commits into
Conversation
|
Warning Rate limit exceeded
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 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 configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
|
@drtechie Would appreciate your review and feedback. Thanks! |
📝 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:
docs/ARCHITECTURE.mdwith full ecosystem overviewREADME.md✅ Type of Change
ℹ️ 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:
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.