Skip to content

docs(skillfs): add lightweight and detailed user guides#1186

Merged
yummypeng merged 1 commit into
alibaba:mainfrom
kongche-jbw:doc/skillfs
Jul 7, 2026
Merged

docs(skillfs): add lightweight and detailed user guides#1186
yummypeng merged 1 commit into
alibaba:mainfrom
kongche-jbw:doc/skillfs

Conversation

@kongche-jbw

Copy link
Copy Markdown
Collaborator

Summary

Add user-facing SkillFS documentation with a lightweight entry guide and a
detailed component reference.

What Changed

  • Add docs/skillfs/skillfs.md as the short user guide.

    • Explains what SkillFS is.
    • Covers normal mount, in-place mount, common parameters, and quick checks.
    • Links to the detailed SkillFS reference for advanced usage.
  • Add src/skillfs/docs/user-guide.md as the full reference.

    • Covers view semantics, activation file mode, notify socket, reload,
      control socket, trusted writer, install protocols, and config examples.
    • Documents both production activation/control-socket mode and
      decision-command compatibility mode.
    • Keeps activation file semantics accurate: activation JSON expresses
      fallback snapshot or hidden; current is not written through activation JSON.

Behavior / Compatibility

  • Documentation-only change.
  • No runtime behavior, CLI behavior, or test behavior changes.
  • Source-build examples explicitly use the src/skillfs workspace path.
  • Security integration docs avoid mixing mutually exclusive modes.

Validation

  • git diff --check
  • cd src/skillfs && cargo +1.86.0 fmt --all --check

Comment thread src/skillfs/docs/user-guide.md Outdated
Comment thread src/skillfs/docs/user-guide.md Outdated
Comment thread src/skillfs/docs/user-guide.md Outdated
Comment thread docs/skillfs/skillfs.md Outdated
Comment thread src/skillfs/docs/user-guide.md Outdated
@kongche-jbw

Copy link
Copy Markdown
Collaborator Author

@1570005763 已处理这几处文档问题:

  1. 明确区分 normal mount 和 in-place mount 的访问路径:
    normal mount 是 /skills/,in-place mount 是 /。
  2. 修正 in-place 验证命令,不再写成 /skills/。
  3. OpenClaw/ClawHub 示例补充 .clawhub/** post-publish 白名单。
  4. trusted writer / trusted peer 说明改为“最终执行进程 exe”,避免把 shell wrapper 路径写成可信 exe。
  5. 修复 docs/skillfs/skillfs.md 到 user-guide.md 的相对链接。
  6. 新增 OpenClaw in-place + Skill Ledger 推荐启动命令和 TOML 示例。

已推送 commit: 29a3716

@yummypeng

Copy link
Copy Markdown
Collaborator

这两份文档要搞成一模一样的标题吗? 是不是一个改成 SkillFS 快速入门 之类的?

@1570005763

1570005763 commented Jul 1, 2026

Copy link
Copy Markdown
Collaborator

@kongche-jbw LGTM. The issues I raised have been addressed in 29a3716.

- Move PR guide content into the new user-guide docs layout.
- Cover mount modes, activation, control socket, and install flows.

Signed-off-by: 空澈 <kongche.jbw@alibaba-inc.com>

@yummypeng yummypeng left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM

@yummypeng yummypeng merged commit cb23019 into alibaba:main Jul 7, 2026
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants