Skip to content

docs: add architecture diagram and dynamic contributors section to README#67

Open
Vi-bha wants to merge 1 commit into
FireFistisDead:masterfrom
Vi-bha:docs/update-readme-diagram
Open

docs: add architecture diagram and dynamic contributors section to README#67
Vi-bha wants to merge 1 commit into
FireFistisDead:masterfrom
Vi-bha:docs/update-readme-diagram

Conversation

@Vi-bha
Copy link
Copy Markdown
Contributor

@Vi-bha Vi-bha commented May 20, 2026

Added Mermaid architecture diagram showing the complete request lifecycle across all three services (React, Express, FastAPI + FAISS), and a dynamic contributors section using contrib.rocks that auto-updates when new contributors join.

@github-actions github-actions Bot added backend Express or API gateway work docs Documentation only documentation Improvements or additions to documentation enhancement New feature or request feature A new feature or improvement frontend Frontend-related work rag-service FastAPI / model service work type:docs labels May 20, 2026
@FireFistisDead FireFistisDead self-requested a review May 20, 2026 06:33
Copy link
Copy Markdown
Owner

@FireFistisDead FireFistisDead left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Vi-bha the contributo section is here

Image

but you made another contributors section in the last which is here

Image

and also there are 2 contributors shown but repo has more contributors and also i said that the section should dynamically add contributors if anoter new contributor comes

@Krishnapriya1911
Copy link
Copy Markdown

Hi @Vi-bha 👋

This documentation improvement looks really helpful for the project. I would love to contribute further enhancements under GSSoC'26.

I can help with:
• Improving README structure and formatting
• Adding better architecture/workflow diagrams
• Enhancing setup instructions and contributor guidance
• Improving responsiveness/visual organization of documentation
• Adding additional API/project flow explanations

Please let me know if I can work on a follow-up contribution or related enhancement. 🚀

@FireFistisDead
Copy link
Copy Markdown
Owner

@Vi-bha whats he update?

@FireFistisDead
Copy link
Copy Markdown
Owner

@Vi-bha ??

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

Labels

backend Express or API gateway work docs Documentation only documentation Improvements or additions to documentation enhancement New feature or request feature A new feature or improvement frontend Frontend-related work rag-service FastAPI / model service work type:docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants