[GH-ISSUE #3894] [Feature Request] 感觉中文文档描述配置参数，容易让新手出错。

gitea-mirror commented

2026-05-05 13:59:59 -06:00

Owner

Copy link

Originally created by @superzjg on GitHub (Dec 25, 2023).
Original GitHub issue: https://github.com/fatedier/frp/issues/3894

Describe the feature request

希望写清楚参数的上级和下级。现在排版看上去，新手容易忽略上级。
例如：https://github.com/fatedier/frp/issues/3890
就是忽略了 token 是有上级 auth 的。
上次在其他网站也有人提到类似问题。

Describe alternatives you've considered

No response

Affected area

Docs
Installation
Performance and Scalability
Security
User Experience
Test and Release
Developer Infrastructure
Client Plugin
Server Plugin
Extensions
Others

Originally created by @superzjg on GitHub (Dec 25, 2023). Original GitHub issue: https://github.com/fatedier/frp/issues/3894 ### Describe the feature request 希望写清楚参数的上级和下级。现在排版看上去，新手容易忽略上级。例如：https://github.com/fatedier/frp/issues/3890 就是忽略了 token 是有上级 auth 的。上次在其他网站也有人提到类似问题。 ### Describe alternatives you've considered _No response_ ### Affected area - [X] Docs - [ ] Installation - [ ] Performance and Scalability - [ ] Security - [ ] User Experience - [ ] Test and Release - [ ] Developer Infrastructure - [ ] Client Plugin - [ ] Server Plugin - [ ] Extensions - [ ] Others

gitea-mirror closed this issue

2026-05-05 14:00:00 -06:00

gitea-mirror commented

2026-05-05 14:00:03 -06:00

Author

Owner

Copy link

@fatedier commented on GitHub (Dec 26, 2023):

https://gofrp.org/zh-cn/docs/reference/server-configures/
这个描述的清楚吗，如果还无法理解，建议去其他论坛之类的地方寻求帮助吧

@fatedier commented on GitHub (Dec 26, 2023): https://gofrp.org/zh-cn/docs/reference/server-configures/ 这个描述的清楚吗，如果还无法理解，建议去其他论坛之类的地方寻求帮助吧

gitea-mirror commented

2026-05-05 14:00:03 -06:00

Author

Owner

Copy link

@superzjg commented on GitHub (Dec 26, 2023):

https://gofrp.org/zh-cn/docs/reference/server-configures/ 这个描述的清楚吗，如果还无法理解，建议去其他论坛之类的地方寻求帮助吧

我个人完全没问题，在其他论坛我都是帮别人（新手）解释。
现在发文档链接，我都不发这个中文文档链接了，发出来，他们很多不添加上级，写参数出错，然后不停的追问。
现在改发这个frpc_full_example.toml了：
https://github.com/fatedier/frp/blob/dev/conf/frpc_full_example.toml
反而都说能看明白。

@superzjg commented on GitHub (Dec 26, 2023): > https://gofrp.org/zh-cn/docs/reference/server-configures/ 这个描述的清楚吗，如果还无法理解，建议去其他论坛之类的地方寻求帮助吧我个人完全没问题，在其他论坛我都是帮别人（新手）解释。现在发文档链接，我都不发这个中文文档链接了，发出来，他们很多不添加上级，写参数出错，然后不停的追问。现在改发这个frpc_full_example.toml了： https://github.com/fatedier/frp/blob/dev/conf/frpc_full_example.toml 反而都说能看明白。

gitea-mirror commented

2026-05-05 14:00:05 -06:00

Author

Owner

Copy link

@fatedier commented on GitHub (Dec 26, 2023):

那没问题，所以我上面也说了论坛更适合没有任何基础的用户，互相之间讨论，寻求帮助，不会把问题都堆积到一个人身上。Github 面向的主要不是什么都不懂，想要点开一个软件直接用的用户，对于类似的 issue 基本上也不会回复。

当前的格式基本上是很常见的云原生项目里的 Reference 格式，不太会为了几乎不看文档的人再去特意做什么调整。

很多人只是惯性，不习惯自己尝试解决问题，习惯了有问题直接寻求他人帮助。作为开发者也不是保姆，一定要把饭喂到嘴里。
https://gofrp.org/zh-cn/docs/features/common/authentication/
提问之前能够先看一看文档的话，也算是一种对开发者的尊重吧，有的 issue 也不会存在了。

@fatedier commented on GitHub (Dec 26, 2023): 那没问题，所以我上面也说了论坛更适合没有任何基础的用户，互相之间讨论，寻求帮助，不会把问题都堆积到一个人身上。Github 面向的主要不是什么都不懂，想要点开一个软件直接用的用户，对于类似的 issue 基本上也不会回复。当前的格式基本上是很常见的云原生项目里的 Reference 格式，不太会为了几乎不看文档的人再去特意做什么调整。很多人只是惯性，不习惯自己尝试解决问题，习惯了有问题直接寻求他人帮助。作为开发者也不是保姆，一定要把饭喂到嘴里。 https://gofrp.org/zh-cn/docs/features/common/authentication/ 提问之前能够先看一看文档的话，也算是一种对开发者的尊重吧，有的 issue 也不会存在了。

gitea-mirror commented

2026-05-05 14:00:06 -06:00

Author

Owner

Copy link

@ZimaBlueee commented on GitHub (Mar 12, 2024):

#3890 是我提出来的. 从当时的描述能看出, 我是愿意看文档并翻issue找答案的, 后面才知道是因为我没遇到过这种格式的文档, 不能像以前那样直接Ctrl+F找参数, 而是定位到参数后, 需要从下往上的找其上级, 以及上级的上级....

toml格式我是第一次用, 但与之类似的yml我经常用, 在Spring官网里, yml的配置是从父级到子级都写全的, 不过这也得益于Spring支持properties配置.

作者提到官网的文档是云原生的通用写法, 这样的话文档确实不必修改, 大家通过这些issue学习到不同文档的阅读方式也算是推进知识点扫盲了.

@ZimaBlueee commented on GitHub (Mar 12, 2024): #3890 是我提出来的. 从当时的描述能看出, 我是愿意看文档并翻issue找答案的, 后面才知道是因为我没遇到过这种格式的文档, 不能像以前那样直接`Ctrl+F`找参数, 而是定位到参数后, 需要**从下往上**的找其上级, 以及上级的上级.... toml格式我是第一次用, 但与之类似的yml我经常用, 在[Spring官网](https://docs.spring.io/spring-boot/docs/2.7.18/reference/html/application-properties.html#appendix.application-properties)里, yml的配置是从父级到子级都写全的, 不过这也得益于Spring支持properties配置. 作者提到官网的文档是云原生的通用写法, 这样的话文档确实不必修改, 大家通过这些issue学习到不同文档的阅读方式也算是推进知识点扫盲了.

No Branch/Tag specified