[Docs] Consolidate environment variables reference in docs/configuration.md - #5
Merged
Yunaik merged 1 commit intoSep 24, 2026
Conversation
Collaborator
|
Thanks for picking this up and following the issue closely. The table has the right shape and most rows match the code. A few fixes before merge:
Happy to merge once these are in. |
…on.md - Create docs/configuration.md with reference table for all environment variables. - Document variable name, reader model or subsystem, default value, and description. - Set accurate code defaults for TYPESAFE_API_URL and library defaults for LAYA_*. - Link configuration.md in Docs list of README.md. - Prune redundant per-page variable documentation in docs and evals down to pointers. - Update documentation to reference models rather than slots. - Add entry to CHANGELOG.md.
ChaitanyaAIML-lab
force-pushed
the
contributions/issue-1
branch
from
September 23, 2026 10:58
82dd165 to
9ac14de
Compare
Contributor
Author
|
Thank you for the detailed review and guidance, @Yunaik! All requested changes are now in place and rebased on latest main:
Verified locally with |
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
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.
Summary
Consolidate 31 environment variables across the project into a single reference table in docs/configuration.md, with cross-references from README.md, docs, and evals.
Closes #1
Why
Environment variables were previously documented across multiple locations (.env.example, README.md, docs/decision-models.md, docs/skills.md, and evals/README.md). New contributors and users had no central reference to view all variables, default values, and reader subsystems.
What Changed
How to Verify
Run code formatting check:
ruff format --check .
Run lint check:
ruff check .
Run type check:
ty check
Run the unit test suite:
pytest -q