Refactored Folder Structure, Added .env Support, and Improved Documentation#6
Open
nayan458 wants to merge 3 commits intoBUPT-GAMMA:mainfrom
Open
Refactored Folder Structure, Added .env Support, and Improved Documentation#6nayan458 wants to merge 3 commits intoBUPT-GAMMA:mainfrom
nayan458 wants to merge 3 commits intoBUPT-GAMMA:mainfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes Introduced:
✅ Refactored Folder Structure:
Separated storage for graph, kv_store, and vdb files to improve organization.
Added .gitignore file and included them so that it do not get pushed as well.
✅ Added .env Support
Introduced an .env file for managing environment variables, making configuration more flexible and secure.
A template of it is provided so that the users can follow it without exposing their real API keys
✅ Improved Documentation
Updated documentation to reflect the new folder structure and .env usage.
Why These Changes?
🔹 Better Organization: Improved maintainability by structuring files logically.
🔹 Easier Configuration: Using .env makes it simpler to manage different environments.
🔹 Improved Documentation: Helps future contributors understand the structure more easily.
Let me know if you'd like any modifications! 🚀