Skip to content

chore: improve .env.example documentation #200

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.

Sign up for GitHub

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

Jump to bottom
Open
iamgurjitsingh wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: improve .env.example documentation #200

iamgurjitsingh wants to merge 1 commit into from

Conversation

@iamgurjitsingh
Copy link
Contributor

@iamgurjitsingh iamgurjitsingh commented Dec 3, 2025

  • Improve .env.example documentation
  • Convert inline comments to multi-line format for better readability
  • Add more descriptive explanations for each configuration option
  • Maintain professional tone while preserving important guidance
  • Better explain use cases (e.g., air-gapped environments)

@iamgurjitsingh
chore:improve .env.example documentation
cb3316b 
  - Improve .env.example documentation
  - Convert inline comments to multi-line format for better readability
  - Add more descriptive explanations for each configuration option
  - Maintain professional tone while preserving important guidance
  - Better explain use cases (e.g., air-gapped environments)
@iamgurjitsingh
Copy link
Contributor Author

iamgurjitsingh commented Dec 6, 2025

Hi @JovannMC Please review and merge. I found the .env very confusing without proper commenting. Thanks, Gurjit

@iamgurjitsingh
Copy link
Contributor Author

iamgurjitsingh commented Dec 8, 2025

Thanks @JovannMC for the approval ;)

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

Reviewers

@JovannMC JovannMC JovannMC approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@iamgurjitsingh @JovannMC