search

llmware-ai / llmware

Unified framework for building enterprise RAG pipelines with small, specialized models
https://llmware-ai.github.io/llmware/
Apache License 2.0
6.57k stars 1.52k forks source link

[DOC] Breaking the README into multiple files #1018

Open Vignesh025 opened 1 month ago

Vignesh025 commented 1 month ago

The README is quite lengthy, and it might be better to split it into multiple files for better readability and organization. We can break down the different sections (e.g., installation, contributing, release notes and changelogs) into their own files, and link them back to the main README for easy reference.

If you think this is a good idea , Assign me to this issue and I'll start working on it.

PRIYANKjakharia commented 1 month ago

I don't mind working on it or assisting you as well.

AMANCHAUBEY2277 commented 1 month ago

i will working with you

Vignesh025 commented 1 month ago

@PRIYANKjakharia and @AMANCHAUBEY2277, thank you for your interest, but I am currently working on this issue myself if it's assigned to me. Appreciate your understanding!

NYDocutest commented 1 month ago

Hi I assigned @Vignesh025 to this issue - but to @PRIYANKjakharia and @AMANCHAUBEY2277 I do think that there is significant room for improvement in the Read Me - even some graphics to make it more visually interesting, etc. as well so please post here other ideas you may have regarding the Read Me. THANK YOU!!!

Vignesh025 commented 1 month ago

@NYDocutest , Thankyou for assigning this issue to me.