docs(faq): supplement FAQ (zh & en) with community-sourced Q&A#529
docs(faq): supplement FAQ (zh & en) with community-sourced Q&A#529FenjuFu wants to merge 3 commits into
Conversation
FenjuFu
commented
Jun 15, 2026
FenjuFu
commented
Add questions frequently raised in the user community that were not yet covered in the SkillHub FAQ, for both Chinese and English pages: - Recommended deployment via the one-line script vs manual image pulls - Redirected back to login page after deploying (manual deployment) - Changing the admin password / why env changes need a restart - Password change/reset requires email code (SMTP setup) - Skill naming (English only; Chinese names error in OpenClaw) - Whether unreviewed skills can be downloaded - Hiding/removing GitHub & GitLab SSO login options - Built-in Skill Scanner: iFLYTEK integration over Cisco's scanner (Apache-2.0) - Which cisco-ai-skill-scanner version is used (unpinned in Dockerfile) - Note that upgrades preserve registered skills; online docs link Signed-off-by: FenjuFu <fufenjupku@gmail.com>
Signed-off-by: FenjuFu <fufenjupku@gmail.com>
FenjuFu
force-pushed
the
faq/add-community-qa
branch
from
b6d34da to
e3f84b0
Compare
Add more community-sourced questions (both Chinese and English): - Troubleshooting CLI `skillhub publish` returning 400 (name conflict, SKILL.md location/frontmatter, namespace membership, etc.) - Required skill package structure (SKILL.md in root) - "malformed input" on publish caused by non-UTF-8 / Chinese-path zips - Per-package file-count limit and how to raise it - Minimum server version for CLI features (v0.2.7+) - PostgreSQL-only (no MySQL); plugins not distributable yet - How to check server/CLI versions and customize via secondary dev Signed-off-by: FenjuFu <fufenjupku@gmail.com>
FenjuFu
requested review from
XiaoSeS and
Copilot
and removed request for
XiaoSeS
There was a problem hiding this comment.
Pull request overview
This PR expands the SkillHub FAQ (Chinese and English) with additional community-sourced Q&A, primarily covering deployment/operations, CLI publishing troubleshooting, packaging constraints, and support links.
Changes:
- Add multiple new FAQ entries around recommended deployment, login redirect issues, admin password changes, SMTP setup, publishing errors, and skill package constraints.
- Add clarification text to the upgrade note and add an “Online Docs” support link.
- Mirror the same FAQ additions in both
zhandenvariants.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| docs/skillhub/faq.md | Adds extensive new Chinese FAQ entries and expands upgrade/support guidance. |
| docs/skillhub/en/faq.md | Adds corresponding English FAQ entries and expands upgrade/support guidance. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ``` | ||
|
|
||
| > **注意**：升级前建议先备份数据库和对象存储。数据库迁移由 Flyway 自动执行。 | ||
| > **注意**：升级前建议先备份数据库和对象存储。数据库迁移由 Flyway 自动执行。升级不会清空数据库，已录入的技能包不会丢失。 |
| SKILLHUB_PUBLISH_MAX_FILE_COUNT=500 | ||
| ``` | ||
|
|
||
| 修改后需重启容器生效。注意 `compose.release.yml` 中也需引用该变量；较旧版本（如 v0.2.6）可能将该值写死，建议升级到最新版本。 |
| ``` | ||
|
|
||
| > **Note**: It is recommended to back up the database and object storage before upgrading. Database migrations are handled automatically by Flyway. | ||
| > **Note**: It is recommended to back up the database and object storage before upgrading. Database migrations are handled automatically by Flyway. Upgrading does not wipe the database, so already-registered skill packages will not be lost. |
| SKILLHUB_PUBLISH_MAX_FILE_COUNT=500 | ||
| ``` | ||
|
|
||
| Restart the containers for the change to take effect. Note that `compose.release.yml` must also reference this variable; older versions (e.g. v0.2.6) may hard-code the value, so upgrading to the latest version is recommended. |
|
感谢补充这批社区 FAQ，覆盖了部署、CLI 发布、SMTP、Scanner、数据库支持等高频问题，对降低用户排障成本很有帮助。 建议先做几处小修正再合并，主要是避免文档说明和当前实现不一致：
|
