docs(patrol): add install command + Slack branding config (2026-05-30)#572
Merged
Merged
Conversation
- cli.md: add `hotplex install` to command tree and reference section - configuration.md: add display_name/icon_emoji to Slack and SlackBotConfig tables
hotplex-ai
reviewed
May 29, 2026
Owner
hotplex-ai
left a comment
There was a problem hiding this comment.
Code Review — hotplex-ai
Verdict: APPROVE | P0:0 P1:0 P2:0 P3:2
- [P3] Flag table column schema inconsistency between install and update sections (docs/reference/cli.md:318) — The
hotplex updateflag table (line 318) uses 5 columns: 标志 | 短标志 | 类型 | 默认值 | 说明. The newhotplex installflag table (added in this PR) uses only 4 columns: 标志 | 类型 | 默认值 | 说明, omitting the 短标志 column. While the install command has no short flags (confirmed in cmd/hotplex/install.go), omitting the column breaks visual consistency with the update table directly above it. Best practice for doc consistency: include the 短标志 column with empty cells to maintain a uniform table schema across the same document.
Lines 317 to 319 in 698b5ee
- [P3] SlackBotConfig doc table omits pre-existing per-bot access control fields (work_dir, dm_policy, group_policy, require_mention, allow_from, allow_dm_from, allow_group_from) (docs/reference/configuration.md:449) — The SlackBotConfig table at line 449 lists only name, bot_token, app_token, worker_type, stt_, tts_. However, the actual struct in internal/config/config.go (lines 279-299) also has work_dir, dm_policy, group_policy, require_mention, allow_from, allow_dm_from, allow_group_from fields. This is a pre-existing gap (not introduced by this PR), but this PR adds display_name and icon_emoji to the same table while the access control fields remain undocumented. The PR should ideally either document all missing fields or note them as intentionally omitted, to avoid giving a false impression of completeness after the branding additions.
hotplex/docs/reference/configuration.md
Lines 448 to 450 in 698b5ee
hotplex-ai
reviewed
May 29, 2026
Owner
hotplex-ai
left a comment
There was a problem hiding this comment.
Code Review — hotplex-ai
Verdict: APPROVE | P0:0 P1:0 P2:0 P3:2
- [P3] Flag table column schema inconsistency between install and update sections (docs/reference/cli.md:318) — The
hotplex updateflag table (line 318) uses 5 columns: 标志 | 短标志 | 类型 | 默认值 | 说明. The newhotplex installflag table (added in this PR) uses only 4 columns: 标志 | 类型 | 默认值 | 说明, omitting the 短标志 column. While the install command has no short flags (confirmed in cmd/hotplex/install.go), omitting the column breaks visual consistency with the update table directly above it. Best practice for doc consistency: include the 短标志 column with empty cells to maintain a uniform table schema across the same document.
Lines 317 to 319 in 698b5ee
- [P3] SlackBotConfig doc table omits pre-existing per-bot access control fields (work_dir, dm_policy, group_policy, require_mention, allow_from, allow_dm_from, allow_group_from) (docs/reference/configuration.md:449) — The SlackBotConfig table at line 449 lists only name, bot_token, app_token, worker_type, stt_, tts_. However, the actual struct in internal/config/config.go (lines 279-299) also has work_dir, dm_policy, group_policy, require_mention, allow_from, allow_dm_from, allow_group_from fields. This is a pre-existing gap (not introduced by this PR), but this PR adds display_name and icon_emoji to the same table while the access control fields remain undocumented. The PR should ideally either document all missing fields or note them as intentionally omitted, to avoid giving a false impression of completeness after the branding additions.
hotplex/docs/reference/configuration.md
Lines 448 to 450 in 698b5ee
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.
文档巡逻 2026-05-30
自
a8499cd以来 12 个提交,经分析 2 篇文档需要维护。修复内容
变更来源
未修改(经阅读确认无影响)