open-cuak icon indicating copy to clipboard operation
open-cuak copied to clipboard

Improve Project Setup Guide & Add Visualized Architecture in README

Open Agastya18 opened this issue 10 months ago • 2 comments

Description: Hello Team,

I’m excited to contribute to Aident-AI and appreciate the work you’ve done so far! While setting up the project locally, I faced some challenges and believe adding two key improvements would help new contributors onboard quickly:

1️⃣ Short Video Walkthrough for Setup I encountered some issues while setting up the project. A 2-3 minute video guide showing how to set up the project locally would be helpful. Updating the README with troubleshooting steps would also assist new contributors.

2️⃣ Add a Visualized Project Flow in README

A flow diagram or system architecture visualization in the README would help new contributors understand the code structure faster. Suggested visuals: High-level architecture (frontend/backend interaction, APIs, database) Request/response flow Core modules & how they interact Would love to hear your thoughts on this! I’d be happy to assist in refining the setup documentation based on my experience. 😊

Agastya18 avatar Feb 19 '25 09:02 Agastya18

Makes sense, we will work on it.

yuleisheng avatar Feb 19 '25 15:02 yuleisheng

I can take on this, but this probably will come after I fix the quick-start for production build. ETA early next week.

ljhskyso avatar Feb 20 '25 05:02 ljhskyso