From 00dfe1db9312f1b7ee30769bd51bc707260b754b Mon Sep 17 00:00:00 2001 From: fankesyooni Date: Sat, 15 Nov 2025 21:52:21 +0800 Subject: [PATCH] docs: update quick-start --- docs-source/src/en/guide/quick-start.md | 13 ++++++++++++- docs-source/src/zh-cn/guide/quick-start.md | 8 ++++++++ 2 files changed, 20 insertions(+), 1 deletion(-) diff --git a/docs-source/src/en/guide/quick-start.md b/docs-source/src/en/guide/quick-start.md index d9fdf7e..7cbdd80 100644 --- a/docs-source/src/en/guide/quick-start.md +++ b/docs-source/src/en/guide/quick-start.md @@ -74,8 +74,19 @@ If you don't want to use Kotlin DSL entirely, you can also migrate only `setting ```kotlin gropify { - // Enable Gropify, setting it to `false` will disable all features + // Enable Gropify, setting it to `false` will disable all features. isEnabled = true + + // Whether to enable debug mode. + // + // You can help us identify the problem by enabling this option + // to print more debugging information in the logs. + // + // - Note: THIS IS ONLY FOR DEBUGGING! + // The debug log will contain your local environment, + // which may contain sensitive information. + // Please be sure to protect this information. + debugMode = false } ``` diff --git a/docs-source/src/zh-cn/guide/quick-start.md b/docs-source/src/zh-cn/guide/quick-start.md index 662bfa8..72afd11 100644 --- a/docs-source/src/zh-cn/guide/quick-start.md +++ b/docs-source/src/zh-cn/guide/quick-start.md @@ -76,6 +76,14 @@ plugins { gropify { // 启用 Gropify,设置为 `false` 将禁用所有功能 isEnabled = true + + // 是否启用调试模式 + // + // 你可以通过启用此选项在日志中打印更多调试信息帮助我们定位问题 + // + // - 注意: 此功能仅用于调试! + // 调试日志将包含你的本地环境,其中可能包含敏感信息,请务必保护好这些信息 + debugMode = false } ```