Skip to content

Improve Project Setup Guide & Add Visualized Architecture in README #31

Description

@Agastya18

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. 😊

Activity

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

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions