Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance Environment Configuration Files with Clarity and Documentation #777

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

UTSAVS26
Copy link

This PR improves the clarity, formatting, and documentation of environment configuration files (.env.example, .env.ai.example, and CONTRIBUTING.md). These changes aim to make it easier for contributors and developers to understand and modify the configuration settings. Below is a summary of the changes:


1. Updated .env.example

  • Added detailed comments to clarify the purpose of each variable.
  • Grouped variables logically into sections like Service Ports, LLM Settings, Version Information, etc.
  • Improved the organization and readability of settings to help users easily identify and update necessary values.
  • Ensured consistency in variable names and descriptions.

2. Updated .env.ai.example

  • Enhanced comments and formatting for each section, including LLM (Language Learning Model), Embedder, Document Store, and Langfuse Integration.
  • Clarified the purpose of key variables like API keys, models, and service endpoints.
  • Provided explanations for embedding models and LLM configurations, improving the documentation for both OpenAI and Azure OpenAI settings.

3. Updated CONTRIBUTING.md

  • Corrected grammar, typos, and language consistency.
  • Added clarity to instructions on contributing to different services, including the use of environment variables and Docker Compose setup.
  • Improved the professional tone and readability of the document to align with the project's goals of creating a welcoming and informative space for contributors.

@paopa paopa requested review from paopa and cyyeh October 21, 2024 07:55
@cyyeh
Copy link
Member

cyyeh commented Oct 24, 2024

@UTSAVS26 thanks for contribution, we'll review it asap

@UTSAVS26
Copy link
Author

@UTSAVS26 thanks for contribution, we'll review it asap

Thank you.

@cyyeh
Copy link
Member

cyyeh commented Oct 24, 2024

@UTSAVS26 could you remove updates from .env.ai.example or .env.example? since in the near future, we'll release a new design that replaces old version. so it'll be conflict then if I merge this to the main branch and makes no sense

@UTSAVS26
Copy link
Author

@UTSAVS26 could you remove updates from .env.ai.example or .env.example? since in the near future, we'll release a new design that replaces old version. so it'll be conflict then if I merge this to the main branch and makes no sense

Sure I will remove them and update you regarding it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants