К основному содержанию
скилл CX Codex

skillshare-update-docs — скилл для Claude Code

Скилл skillshare-update-docs синхронизирует документацию проекта skillshare с кодом на Go и сверяет флаги CLI с исходниками. Пригодится после добавления новых команд или опций.

MIT ★ 3 269 обновлён 2026-10-29

Установить в Claude Code · Через Skills CLI (Vercel) Все способы и платформы ↓
npx skills add runkids/skillshare --skill skillshare-update-docs -a claude-code
Открыть на GitHub

Что делает skillshare-update-docs

Скилл отслеживает свежие правки через git diff и находит страницы документации, которые нужно переписать. Он покрывает справочник команд в website/docs/reference/commands/, концептуальные разделы, руководства, FAQ и README.md. Перед работой запускается скрипт python3 scripts/ai-context.py documentation, задающий контекст владения кодом.

Главная проверка — сверка флагов. Скилл открывает парсер в cmd/skillshare/<cmd>.go, находит строковые литералы флагов и требует, чтобы каждый --flag из документации строго присутствовал в Go-коде. Если опцию удалили или переименовали, агент убирает её из таблицы параметров и обновляет примеры вызова.

Перед завершением скилл проверяет лимит описания в skills/skillshare/SKILL.md (до 1024 символов для Codex) и выполняет тестовую сборку npm run build внутри Docker-контейнера. Скилл правит только документацию и встроенное описание: он не пишет реализацию на Go и не заполняет CHANGELOG.

Какие задачи решает

  • найти устаревшие разделы документации по diff коммитов
  • сверить CLI-флаги в Markdown со строковыми литералами в Go
  • обновить примеры вызовов и таблицы параметров команд
  • проверить лимит длины описания встроенного скилла для Codex
  • проконтролировать сборку сайта документации без битых ссылок

Примеры запросов агенту

  • Обнови документацию под последние изменения в ветке
  • Сверь флаги команды install с исходниками и поправь docs
  • Актуализируй README и docs после добавления флага --into

Как установить skillshare-update-docs

1Через Skills CLI (Vercel)

npx skills add runkids/skillshare --skill skillshare-update-docs -a claude-code

2Вручную: положить файлы

~/.claude/skills/skillshare-update-docs/SKILL.md

Папка скилла целиком; для одного проекта — .claude/skills/skillshare-update-docs/

По шагам, с командами для каждой платформы: Как установить скилл в Claude Code: пять способов

Вопросы о skillshare-update-docs

Как установить skillshare-update-docs в Claude Code?

Выполните команду npx skills add runkids/skillshare --skill skillshare-update-docs -a claude-code. Файл скилла запишется в ~/.claude/skills/skillshare-update-docs/SKILL.md.

Что делает скилл skillshare-update-docs?

Он автоматически находит расхождения между кодовой базой skillshare и Markdown-документацией, обновляет описания команд, валидирует флаги и проверяет сборку сайта.

Какие файлы документации обновляет скилл?

Скилл вносит изменения в разделы каталога website/docs/, файл встроенного скилла skills/skillshare/SKILL.md и корневой README.md.

Исходный текст

SKILL.md · MIT
---
name: skillshare-update-docs
description: >-
  Update website docs to match recent code changes, cross-validating every flag
  against source. Use this skill whenever the user asks to: update documentation,
  sync docs with code, document a new flag or command, fix stale docs, or update
  the README. This skill covers all website/docs/ categories (commands, reference,
  understand, how-to, troubleshooting, getting-started) plus the built-in skill
  description and README. If you just implemented a feature and need to update
  docs, this is the skill to use. Never manually edit website docs without
  cross-validating flags against Go source first.
argument-hint: "[command-name | commit-range]"
metadata: 
  targets: [claude, universal]
---

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 updates `website/docs/`, the built-in skill (`skills/skillshare/`), and `README.md`. It does NOT write Go code (use `implement-feature`) or CHANGELOG (use `changelog`).

Before acting, run `python3 scripts/ai-context.py documentation`. That topic is the source of truth for documentation ownership, code cross-validation and verification; this skill retains the update workflow.

## 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. Commands parse arguments by hand, so flags appear as string literals (`"--force"`) in the parse function of `cmd/skillshare/<cmd>.go`; `ss <cmd> --help` inside the devcontainer lists them too.

2. Read the corresponding doc page:
   ```
   website/docs/reference/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 appear as a string literal in the command's 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
docker exec "$CONTAINER" bash -c 'cd /workspace/website && npm run build'   # as the Website Pages workflow builds
```

Confirm no broken links or build errors.

### Step 7: Report

List all changes made with rationale:
```
== Documentation Updates ==

Modified:
  website/docs/reference/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

Apply the `documentation` topic. Keep this adapter scoped to documentation; use the implementation or release workflows for other changes.

© runkids · MIT · runkids/skillshare

Похожие скиллы

Все скиллы по теме «Тексты и документация» →
update-project-docs hoangsonww Скилл update-project-docs для Claude Code обновляет документацию после изменений кода, конфигурации, API, БД или интерфейсов. Агент запускает его при изменении env-переменных, хуков, событий, WebSocket-сообщений и CLI-команд. CX Codex +1 ★ 1 198звёзд репо update-docs-on-code-change официальный github Правило update-docs-on-code-change для GitHub Copilot, которое обновляет README.md и другие файлы документации при изменении кода. Срабатывает, когда новые функции, изменения API или зависимостей требуют правок в описаниях. CX Codex +1 ★ 41 430звёзд репо update-docs rerun-build Скилл update-docs для Claude Code сверяет документацию Rerun с изменениями в коде. Запускается перед завершением работы или созданием PR, если затронуты указанные части проекта, а также по просьбе обновить документацию. CX Codex +1 ★ 1 120звёзд репо update-readme Samarth Gupta Скилл update-readme для Claude Code обновляет существующий README.md по текущему состоянию кода, истории git и CHANGELOG. Обновляет документацию, сверяя её с проектом. CX Codex +1 ★ 276звёзд репо oma-docs First Fluke Сверяет ссылки в документации, обновляет тексты под изменения в коде и находит рассинхрон в переводах. Работает через CLI oma docs или ручной парсинг ссылок. CX Codex +1 ★ 1 472звёзд репо docs-curator First Fluke Субагент docs-curator, который следит за дрейфом документации и обновляет MD-файлы, когда код меняется. Ловит неработающие ссылки, предлагает патчи и держит docs/**/*.md в актуальном состоянии. CX Codex ★ 1 472звёзд репо

Из того же набора10

Весь набор →
skillshare-code-review Скилл skillshare-code-review для Claude Code проверяет изменения в skillshare до создания PR или в открытом pull request. Запускается по просьбе разобрать diff, ветку, диапазон коммитов или PR. CX Codex +1 ★ 3 269звёзд репо skillshare-changelog Скилл skillshare-changelog собирает запись в CHANGELOG.md из коммитов в conventional-формате и переносит её на страницу changelog сайта. CX Codex +1 ★ 3 269звёзд репо skillshare-windows-utm Скилл skillshare-windows-utm проверяет работу skillshare на гостевой Windows в UTM: собирает коммит в devcontainer, передаёт бинарники в виртуалку и запускает E2E-тесты путей и симлинков. CX Codex +1 ★ 3 269звёзд репо skillshare-implement-feature Скилл skillshare-implement-feature ведёт реализацию Go-фичи от спецификации до проверок по TDD. Подходит для новых CLI-команд, флагов и внутренних пакетов. CX Codex +1 ★ 3 269звёзд репо skillshare-devcontainer Скилл skillshare-devcontainer гоняет команды ss, Go-тесты и веб-интерфейс skillshare внутри devcontainer, чтобы на macOS не получить тихо неверный результат. CX Codex +1 ★ 3 269звёзд репо skillshare-release Скилл skillshare-release помогает готовить и проверять релизы skillshare: сверяет PR от Release Please, обновляет документацию и инспектирует черновики. CX Codex +1 ★ 3 269звёзд репо skillshare Управляет ресурсами Skillshare CLI: синхронизирует скиллы и настройки между инструментами, проверяет конфигурацию и работает с общей памятью. CX Codex +1 ★ 3 269звёзд репо skillshare-ui-website-style Скилл skillshare-ui-website-style для Claude Code держит дизайн-систему Skillshare в React-дашборде и сайте на Docusaurus. Покрывает правку стилей и добавление компонентов без расхождения с токенами. CX Codex +1 ★ 3 269звёзд репо

Спонсоры проекта

Компании, которые помогают держать аналитику открытой