feat: [issue #1199/PR2] expand settings help coverage for core config - #1328
Merged
ZhuLinsen merged 3 commits intoMay 17, 2026
Merged
Conversation
Add structured help metadata and bilingual in-app help copy for the PR2 configuration coverage slice, including LLM runtime fields, channel editor fields, data sources, notifications, WebUI, auth, schedule, trading-day, and proxy settings. Clarify restart semantics for startup-only and bind-time settings. WEBUI_HOST and WEBUI_PORT now warn that the running process must be restarted before host or port changes rebind, while RUN_IMMEDIATELY, SCHEDULE_ENABLED, and SCHEDULE_RUN_IMMEDIATELY are marked as startup behavior. Treat SCHEDULE_TIME separately from startup-only schedule switches: an already-running schedule mode can reload the time and rebuild the daily job, but saving the value will not create a scheduler in a non-schedule process. Document settings-help maintenance boundaries and add regression coverage for help metadata, restart warning codes, API warnings, service warnings, and the LLM channel editor help affordance.
🤖 自动审查报告
📁 修改的文件
🧠 AI 代码审查意见结论Ready to Merge 审查结果必要性通过 关联性通过 类型建议类型为 描述完整性完整 风险级别低 必改项无 建议项
|
ZhuLinsen
reviewed
May 17, 2026
ZhuLinsen
left a comment
Owner
There was a problem hiding this comment.
评审结论
- 必要性:通过。Issue #1199 要求扩展设置页帮助覆盖,本 PR 继续补齐核心配置与 LLM Channels 编辑器字段,动机明确。
- 是否有对应 issue:有,Refs #1199。
- PR 类型:feat/docs/test。主要是用户可见的设置帮助能力扩展,同时补充文档与契约测试。
- description 完整性:完整。已说明背景、范围、验证、兼容性、风险、回滚方案,并符合 AGENTS.md 对用户可见变更同步
docs/CHANGELOG.md和专题文档的要求。 - 是否可直接合入:可。当前 CI 全部通过,改动范围与 issue/描述一致,未发现阻断性正确性或兼容性问题;
mergeable_state=blocked在本仓库保护策略下不单独构成不可合入理由。
主要问题
- [Nice to have]
apps/dsa-web/src/locales/settingsHelp.ts新增了多处 provider/model/Base URL/LiteLLM 相关帮助文案和示例,PR 描述说明这些不新增运行时承诺、事实源仍以后续文档为准;结合当前 diff 看更像帮助说明扩展而非运行时变更,不作为阻断。但因结构化检测命中了外部模型/API 兼容风险,建议后续维护时在docs/settings-help.md或相关专题文档中补一个“外部 provider/model 示例不保证长期可用,以官方文档和当前依赖版本为准”的统一说明,降低示例随服务商变化漂移的风险。
🤖 此回复由 OpenReview Bot 自动生成,仅供参考。如有疑问请 @维护者。
Collaborator
|
@Activer007 great job 😁 |
Anyone878
pushed a commit
to Anyone878/daily_stock_analysis
that referenced
this pull request
May 17, 2026
…re config (ZhuLinsen#1328) * feat: expand settings help coverage Add structured help metadata and bilingual in-app help copy for the PR2 configuration coverage slice, including LLM runtime fields, channel editor fields, data sources, notifications, WebUI, auth, schedule, trading-day, and proxy settings. Clarify restart semantics for startup-only and bind-time settings. WEBUI_HOST and WEBUI_PORT now warn that the running process must be restarted before host or port changes rebind, while RUN_IMMEDIATELY, SCHEDULE_ENABLED, and SCHEDULE_RUN_IMMEDIATELY are marked as startup behavior. Treat SCHEDULE_TIME separately from startup-only schedule switches: an already-running schedule mode can reload the time and rebuild the daily job, but saving the value will not create a scheduler in a non-schedule process. Document settings-help maintenance boundaries and add regression coverage for help metadata, restart warning codes, API warnings, service warnings, and the LLM channel editor help affordance. * feat: enhance settings help documentation and improve test coverage --------- Co-authored-by: mumu <42829555+ZhuLinsen@users.noreply.github.com>
Contributor
Author
thanks 😃 |
6 tasks
11 tasks
EchoingFootsteps
pushed a commit
to EchoingFootsteps/daily_stock_analysis
that referenced
this pull request
Jul 4, 2026
…re config (ZhuLinsen#1328) * feat: expand settings help coverage Add structured help metadata and bilingual in-app help copy for the PR2 configuration coverage slice, including LLM runtime fields, channel editor fields, data sources, notifications, WebUI, auth, schedule, trading-day, and proxy settings. Clarify restart semantics for startup-only and bind-time settings. WEBUI_HOST and WEBUI_PORT now warn that the running process must be restarted before host or port changes rebind, while RUN_IMMEDIATELY, SCHEDULE_ENABLED, and SCHEDULE_RUN_IMMEDIATELY are marked as startup behavior. Treat SCHEDULE_TIME separately from startup-only schedule switches: an already-running schedule mode can reload the time and rebuild the daily job, but saving the value will not create a scheduler in a non-schedule process. Document settings-help maintenance boundaries and add regression coverage for help metadata, restart warning codes, API warnings, service warnings, and the LLM channel editor help affordance. * feat: enhance settings help documentation and improve test coverage --------- Co-authored-by: mumu <42829555+ZhuLinsen@users.noreply.github.com>
bmwu
pushed a commit
to bmwu/daily_stock_analysis
that referenced
this pull request
Aug 24, 2026
…re config (ZhuLinsen#1328) * feat: expand settings help coverage Add structured help metadata and bilingual in-app help copy for the PR2 configuration coverage slice, including LLM runtime fields, channel editor fields, data sources, notifications, WebUI, auth, schedule, trading-day, and proxy settings. Clarify restart semantics for startup-only and bind-time settings. WEBUI_HOST and WEBUI_PORT now warn that the running process must be restarted before host or port changes rebind, while RUN_IMMEDIATELY, SCHEDULE_ENABLED, and SCHEDULE_RUN_IMMEDIATELY are marked as startup behavior. Treat SCHEDULE_TIME separately from startup-only schedule switches: an already-running schedule mode can reload the time and rebuild the daily job, but saving the value will not create a scheduler in a non-schedule process. Document settings-help maintenance boundaries and add regression coverage for help metadata, restart warning codes, API warnings, service warnings, and the LLM channel editor help affordance. * feat: enhance settings help documentation and improve test coverage --------- Co-authored-by: mumu <42829555+ZhuLinsen@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Body
PR Type
Background And Problem
Issue #1199 希望提升系统设置页易用性:用户在配置 AI 模型、LLM Channels、数据源、搜索、通知、WebUI、认证和调度等高频字段时,可以直接在页面内查看用途、取值说明、配置样例、影响范围和注意事项。
PR1 #1204 已完成设置帮助基础设施、首批代表字段和统一帮助风格。本 PR 继续实现 issue #1199 建议拆分中的 PR2:扩展核心配置覆盖,并让
LLMChannelEditor内部字段接入相同风格。本 PR 仍保持帮助信息分层原则:后端注册表提供稳定元数据,前端 locale 维护中英文长文案,现有文档继续作为配置事实源。
Scope Of Change
本 PR 是 issue #1199 的 PR2,实现范围与 issue 中“核心配置覆盖”提议对齐:
修改文件范围:
src/core/config_registry.pyhelp_key、examples、docs、warning_codes。AGENT_LITELLM_MODEL、LITELLM_FALLBACK_MODELS、LITELLM_CONFIG、LLM_TEMPERATURE、provider keys、OPENAI_BASE_URL、TUSHARE_TOKEN、TAVILY_API_KEYS、NEWS_STRATEGY_PROFILE、通知字段、报告字段、WebUI/auth/schedule/proxy 字段等。SCHEDULE_TIME从必须重启类 warning 中拆出,使帮助元数据与实际 scheduler runtime 行为一致。src/services/system_config_service.pySCHEDULE_TIME保存后的用户提示:.env写回或调度运行逻辑。apps/dsa-web/src/components/settings/SettingsHelpButton.tsxhelpKey、examples、docs参数,支持LLMChannelEditor这类非 schema 字段直接传入帮助内容。apps/dsa-web/src/components/settings/LLMChannelEditor.tsxSettingsHelpButton/HelpLabel。apps/dsa-web/src/locales/settingsHelp.tssettings.llm_channel.*编辑器内字段帮助 key,并补齐核心配置字段 locale。docs/settings-help.mddocs/deploy-webui-cloud.mddocs/CHANGELOG.md[Unreleased]中补充扁平 changelog 条目:[文档] 扩展 Web 设置页帮助信息,补充 Agent 模型、LiteLLM fallback/config/temperature 与 LLM 渠道编辑器字段说明。tests/test_config_registry.pyTestSettingsHelpContract,验证 registryhelp_key均存在 locale 文案;settings.llm_channel.*作为 editor-only key 单独允许。test_restart_warning_codes_match_runtime_behavior,验证restart_requiredwarning code 与运行时行为一致。test_admin_auth_help_is_read_only_in_generic_settings,验证通用设置页中的认证开关保持只读。tests/test_system_config_api.py、tests/test_system_config_service.pySCHEDULE_TIME保存提示语义。SCHEDULE_TIME回退到默认18:00的提示行为。apps/dsa-web/src/components/settings/__tests__/LLMChannelEditor.test.tsxIssue Link
Refs #1199
本 PR 覆盖 issue #1199 中 PR2 的核心配置覆盖范围。后续 PR 可继续补齐 Agent、回测、报告高级字段、日志、数据库、桌面端和更细分部署配置。
Verification Commands And Results
实际执行过 / 已复核的验证命令:
关键输出/结论:
参考完整验证结果:
Compatibility And Risk
兼容性影响:
潜在风险:
Rollback Plan
如需回滚,直接 revert this PR 即可。该 PR 不包含数据库迁移,不改写用户已有 .env,不需要额外配置或数据回滚。
EXTRACT_PROMPT Change (if applicable)
未修改 src/services/image_stock_extractor.py 中的 EXTRACT_PROMPT。
展开 / Expand: Full EXTRACT_PROMPT
N/AChecklist
docs/CHANGELOG.md;README.md仅在首页级信息变化时更新,细节优先写入docs/*.md/ If user-visible changes are included, relevant docs anddocs/CHANGELOG.mdare updated;README.mdis updated only for homepage-level changes, with details kept indocs/*.md