Document root env configuration#874
Conversation
There was a problem hiding this comment.
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
envto the “Basic/Basics configuration modules” lists in CN/EN/RU index pages with a short description. - Expanded the CN/EN/RU
envfeature pages to document the rootenvobject (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.
…dex/add-env-config-docs # Conflicts: # docs/config/features/env.md # docs/en/config/features/env.md # docs/ru/config/features/env.md
|
@RPRX 改好了。 |
|
文档只保留大写的那种吧(虽然代码仍兼容小写),对环境变量的介绍分为三段,3+2+N,对于 N 像之前一样简单列一下即可 @Fangliding @Meo597 然后你俩看下没问题就合了吧,不用等发版 |
|
已调整。 |
|
看文档发现两个问题,一是应该叫“环境变量”而不是“环境配置”, |
|
我来搞一下吧 |
XTLS/Xray-core#6400 --------- Co-authored-by: yiguodev <147401898+yiguodev@users.noreply.github.com>
XTLS/Xray-core#6400 Co-authored-by: yiguodev <147401898+yiguodev@users.noreply.github.com>
|
好了 93302d5 |
|
本来正文已经写好了怎么修格式还把正文改了 |
|
以前莫名引入了一个 也没讲怎么用 shell 设环境变量,现在既然提到了 conf 必须通过它就应该讲一下 所以我直接重做了这一页 |
|
总之至少文档别保留小写 |
XTLS/Xray-core#6400 Co-authored-by: yiguodev <147401898+yiguodev@users.noreply.github.com>
|
可能跟他那个 PR 最开始的实现方式有关系 不提小写 改好了 |
Summary
envobject in Chinese, English, and Russian.envto the root configuration overview pages.Validation
pnpm docs:buildgit diff --check