Skip to content

Document root env configuration#874

Open
yiguodev wants to merge 7 commits into
XTLS:mainfrom
OneXray:codex/add-env-config-docs
Open

Document root env configuration#874
yiguodev wants to merge 7 commits into
XTLS:mainfrom
OneXray:codex/add-env-config-docs

Conversation

@yiguodev

@yiguodev yiguodev commented Jul 4, 2026

Copy link
Copy Markdown

Summary

  • Document the root-level env object in Chinese, English, and Russian.
  • List supported runtime env keys and preload-only env keys.
  • Add env to the root configuration overview pages.

Validation

  • pnpm docs:build
  • git diff --check

@yiguodev yiguodev marked this pull request as ready for review July 4, 2026 05:34
Copilot AI review requested due to automatic review settings July 4, 2026 05:34

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR expands the configuration documentation to cover the root-level env object across Chinese, English, and Russian docs, and links it from the root configuration overview pages.

Changes:

  • Added "env": {} to the root configuration JSON examples in CN/EN/RU overview pages.
  • Added env to the “Basic/Basics configuration modules” lists in CN/EN/RU index pages with a short description.
  • Expanded the CN/EN/RU env feature pages to document the root env object (supported keys, string value requirement, and priority/restrictions).

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
docs/ru/config/index.md Adds env to the RU root config example and module list.
docs/ru/config/features/env.md Documents RU root-level env object, supported keys, and precedence/restrictions.
docs/en/config/index.md Adds env to the EN root config example and module list.
docs/en/config/features/env.md Documents EN root-level env object, supported keys, and precedence/restrictions.
docs/config/index.md Adds env to the ZH root config example and module list.
docs/config/features/env.md Documents ZH root-level env object, supported keys, and precedence/restrictions.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/en/config/index.md Outdated
Comment thread docs/config/index.md Outdated
yiguo added 5 commits July 4, 2026 13:40
…dex/add-env-config-docs

# Conflicts:
#	docs/config/features/env.md
#	docs/en/config/features/env.md
#	docs/ru/config/features/env.md
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.

3 participants