docs(readme): reorganize and complete env variables documentation #2048
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
abdimo101
changed the title
Junjiequan
force-pushed
the
env-readme-example
branch
2 times, most recently
from
1d10b80 to
86bde99
Compare
Junjiequan
approved these changes
Jul 10, 2025
Junjiequan
force-pushed
the
env-readme-example
branch
from
78bb77b to
0cade76
Compare
Junjiequan
added a commit
that referenced
this pull request
Aug 5, 2025
) * env variables changes in env.example and readme fi * typo fix because of auto formatting when file is saved * description added to some of the env variables * Update README.md * Update README.md * Update .env.example --------- Co-authored-by: Jay <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
env.exampleto match the order specified in the README environment variables.env.example.Motivation
Ensures no environment variables and its default values are overlooked during setup.
Fixes
Changes:
Tests included
Documentation
official documentation info