Skip to content

docs(patrol): add install command + Slack branding config (2026-05-30)#572

Merged
hotplex-ai merged 1 commit into
hrygo:mainfrom
aaronwong1989:docs/patrol-2026-05-30
May 29, 2026
Merged

docs(patrol): add install command + Slack branding config (2026-05-30)#572
hotplex-ai merged 1 commit into
hrygo:mainfrom
aaronwong1989:docs/patrol-2026-05-30

Conversation

@aaronwong1989
Copy link
Copy Markdown
Contributor

文档巡逻 2026-05-30

a8499cd 以来 12 个提交,经分析 2 篇文档需要维护。

修复内容

docs/reference/cli.md
  + 命令树添加 install 节点
  + 新增 hotplex install 命令参考段落(--path / --force 标志)

docs/reference/configuration.md
  + §3.11.5 Slack 专有配置:添加 display_name / icon_emoji 字段
  + §3.11.8 SlackBotConfig:添加 display_name / icon_emoji bot 级覆盖字段

变更来源

未修改(经阅读确认无影响)

- cli.md: add `hotplex install` to command tree and reference section
- configuration.md: add display_name/icon_emoji to Slack and SlackBotConfig tables
Copy link
Copy Markdown
Owner

@hotplex-ai hotplex-ai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 update flag table (line 318) uses 5 columns: 标志 | 短标志 | 类型 | 默认值 | 说明. The new hotplex install flag 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.
    |------|------|--------|------|
    | `--path` | `string` | `~/.local/bin` | 目标安装目录 |
    | `--force` | `bool` | `false` | 即使已安装也重新安装 |
  • [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.
    |------|------|------|
    | `name` | string | Bot 名称(同一平台内唯一,必填) |
    | `bot_token` | string | Slack Bot Token(`xoxb-...`) |

Copy link
Copy Markdown
Owner

@hotplex-ai hotplex-ai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 update flag table (line 318) uses 5 columns: 标志 | 短标志 | 类型 | 默认值 | 说明. The new hotplex install flag 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.
    |------|------|--------|------|
    | `--path` | `string` | `~/.local/bin` | 目标安装目录 |
    | `--force` | `bool` | `false` | 即使已安装也重新安装 |
  • [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.
    |------|------|------|
    | `name` | string | Bot 名称(同一平台内唯一,必填) |
    | `bot_token` | string | Slack Bot Token(`xoxb-...`) |

@hotplex-ai hotplex-ai merged commit 9e0eb3f into hrygo:main May 29, 2026
5 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants