docs/settings-help.md
设置页配置帮助用于把配置项的关键说明放到 WebUI 内部,减少用户在设置页和文档之间反复切换。页面上仍保留短描述,详细说明通过配置项标题旁的 help icon 打开。
本文只说明帮助系统的维护规则,不替代完整配置文档。配置语义、默认值、运行时优先级和排障细节仍以 .env.example、docs/full-guide.md 及对应专题文档为事实源。
后端配置注册表在 src/core/config_registry.py 中为字段追加帮助元数据:
help_key:前端多语言帮助文案的稳定 key。examples:可直接展示的配置样例。敏感字段只能使用占位符,例如 sk-xxxx、your_token。docs:相关文档链接,优先指向仓库内已有专题文档或完整指南。warning_codes:面向前端或后续校验扩展的稳定提示 code。前端长文案维护在 apps/dsa-web/src/locales/settingsHelp.ts:
本轮先覆盖代表性配置项:
STOCK_LISTLITELLM_MODELLLM_CHANNELSFEISHU_WEBHOOK_URLWEBUI_HOST后续 PR 可以按模块继续覆盖 AI 模型、数据源、搜索、通知、WebUI、认证、调度、Agent、回测、报告、代理、日志、数据库和桌面端相关配置。
新增或修改帮助文案时,优先从以下位置核对:
.env.example:配置键名、默认值、样例格式和敏感占位符。docs/full-guide.md:主要配置说明、运行入口和部署上下文。docs/LLM_CONFIG_GUIDE.md、docs/llm-providers.md:LLM 优先级、Channels、provider/model、兼容边界和排障说明。docs/bot/feishu-bot-config.md、docs/deploy-webui-cloud.md、docs/desktop-package.md。.env 写回或环境变量覆盖语义。