技能共享更新文档
- 作者仓库星标 1,897
- 作者仓库 skillshare
- 领域
- 文档
- 作者声明的智能体
- 未找到明确声明;不据此推断已兼容或已测试
- 静态检查
- 88 / 100 · 启发式扫描,不代表运行安全
- 运行环境证据
- 未执行;当前没有隔离运行测试证据
- 作者 / 版本 / 许可证
- @runkids · 未声明许可证
- 上下文用量评级
- 低消耗
- 接入复杂程度
- 即装即用
- 是否需要外部接口密钥
- 不需要
- 兼容的系统
- macOS · Linux · Windows
- 运行环境要求
- 未检出明确要求
- 检测到的文件与系统行为
-
- 只读
- 允许写入 / 修改
- 网络行为
- 仅限本地
- 安装命令数
- 无(仅作为资料)
需要注意: 未声明工具权限范围;实际权限由运行环境决定。
第 6 步:构建验证
确认没有损坏的链接或构建错误。
第7步:报告
列出所有所做的更改及其理由:
Sync website documentation with recent code changes. $ARGUMENTS specifies scope: a command name (e.g., `install`), commit range, or omit to auto-detect from `git diff HEAD~1`.
**Scope**: This skill only updates `website/docs/`. It does NOT write Go code (use `implement-feature`) or CHANGELOG (use `changelog`).
## Workflow
### Step 1: Detect Changes
```bash
# Auto-detect recently changed code
git diff HEAD~1 --stat -- cmd/skillshare/ internal/
# Also check for structural changes that affect concept/reference docs
git diff HEAD~1 --stat -- internal/config/targets.yaml internal/audit/rules.yaml
```
Map changed files to affected documentation using this guide:
**Command docs** (`website/docs/reference/commands/`):
- `cmd/skillshare/<cmd>.go` → `website/docs/reference/commands/<cmd>.md`
- Flag changes, new subcommands, output format changes
**Concept docs** (`website/docs/understand/`):
- `internal/audit/` → `understand/audit-engine.md`
- `internal/sync/` → `understand/sync-modes.md`, `understand/source-and-targets.md`
- `internal/install/tracked.go` → `understand/tracked-repositories.md`
- `internal/config/` → `understand/declarative-manifest.md`
- `.skillshare/` project config changes → `understand/project-skills.md`
- `skills/skillshare/SKILL.md` format → `understand/skill-format.md`
**Reference docs** (`website/docs/reference/`):
- `internal/config/targets.yaml` → `reference/targets/`
- `internal/audit/rules.yaml` → `reference/commands/audit-rules.md`
- `reference/appendix/` for CLI quick-reference tables
**How-to guides** (`website/docs/how-to/`):
- New workflow patterns → `how-to/daily-tasks/`, `how-to/advanced/`, `how-to/recipes/`
- Sharing/org features → `how-to/sharing/`
**Troubleshooting** (`website/docs/troubleshooting/`):
- New error messages → `troubleshooting/common-errors.md`
- FAQ additions → `troubleshooting/faq.md`
**Getting started** (`website/docs/getting-started/`):
- Breaking changes to init/install flow → `getting-started/first-sync.md`
- Quick reference updates → `getting-started/quick-reference.md`
**Learn** (`website/docs/learn/`):
- New target integrations → `learn/with-<tool>.md`
### Step 2: Cross-Validate Flags
For each affected command:
1. Read the Go source to extract actual flags and behavior:
```bash
grep -n 'flag\.\|Usage\|Args' cmd/skillshare/<cmd>.go
```
2. Read the corresponding doc page:
```
website/docs/commands/<cmd>.md
```
3. Compare and fix:
- **New flags** in code → add to docs with usage example
- **Removed flags** from code → remove from docs
- **Changed behavior** → update description
- **Every `--flag` in docs** must have a matching `grep` hit in source
### Step 3: Update Documentation
Apply changes following existing doc conventions:
- Match heading structure of neighboring doc pages
- Include CLI examples with expected output
- Keep flag tables consistent in format
### Step 4: Check Built-in Skill
If changes affect user-visible CLI behavior:
1. Read `skills/skillshare/SKILL.md`
2. Check if the built-in skill description needs updating
3. Verify description stays under 1024 characters (CodeX limit)
### Step 5: Check README
Review `README.md` for sections that may need updates:
- Recent Updates callout
- Why skillshare bullet points (5 selling points)
- Highlights section (core feature examples)
### Step 6: Build Verification
```bash
cd website && npm run build
```
Confirm no broken links or build errors.
### Step 7: Report
List all changes made with rationale:
```
== Documentation Updates ==
Modified:
website/docs/commands/install.md
- Added --into flag documentation
- Updated install examples
skills/skillshare/SKILL.md
- Added --into to feature list (desc: 987/1024 chars)
Build: PASS (no broken links)
```
## Rules
- **Source of truth is code** — docs must match what the code actually does
- **Every flag claim must be verified** — grep source before writing docs
- **No speculative docs** — never document planned but unimplemented features
- **No code changes** — this skill only touches `website/docs/`, `skills/skillshare/SKILL.md`, and `README.md`
- **Preserve style** — match existing doc page structure and tone
- **Built-in skill desc limit** — must stay under 1024 characters
章节与文件索引
按说明文件中的顺序排列。
第 1 步:检测变化
第 2 步:交叉验证标志
第 3 步:更新文档
第四步:检查内置技能
第 5 步:检查自述文件
文件/命令 -> install · git diff HEAD~1 · website/docs/ · implement-feature · changelog · website/docs/reference/commands/ · cmd/skillshare/<cmd>.go · website/docs/reference/commands/<cmd>.md
内容校验值 -> 49fbcf3277ad
当前原文的自动摘译,尚未人工审校。
第 1 步:检测变化
使用本指南将更改的文件映射到受影响的文档: 命令文档 (
website/docs/reference/commands/):cmd/skillshare/<cmd>.go→website/docs/reference/commands/<cmd>.md标志更改、新子命令、输出格式更改 概念文档 (website/docs/understand/):第 2 步:交叉验证标志
对于每个受影响的命令:阅读 Go 源代码以提取实际的标志和行为:阅读相应的文档页面:比较并修复:代码中的新标志→使用示例添加到文档
第 3 步:更新文档
按照现有文档约定应用更改: 匹配相邻文档页面的标题结构 包含具有预期输出的 CLI 示例 保持标志表格式一致
第四步:检查内置技能
如果更改影响用户可见的 CLI 行为: 阅读
skills/skillshare/SKILL.md检查内置技能描述是否需要更新 验证描述保持在 1024 个字符以下(CodeX 限制)第 5 步:检查自述文件
查看
README.md,了解可能需要更新的部分: 最近更新标注 为什么 Skillshare 要点(5 个卖点) 亮点部分(核心功能示例)