diff --git a/.gemini/skills/doc-mirror-sync/SKILL.md b/.gemini/skills/doc-mirror-sync/SKILL.md index eabac26..c83492e 100644 --- a/.gemini/skills/doc-mirror-sync/SKILL.md +++ b/.gemini/skills/doc-mirror-sync/SKILL.md @@ -8,7 +8,43 @@ description: Automatically synchronizes plugin READMEs to the official documenta ## Overview Automates the mirroring of `plugins/{type}/{name}/README.md` to `docs/plugins/{type}/{name}.md`. +## Docs-Only Mode (No Release Changes) +Use this mode when the request is "only sync docs". + +- Only update documentation mirror files under `docs/plugins/**`. +- Do **not** bump plugin version. +- Do **not** modify plugin code (`plugins/**.py`) unless explicitly requested. +- Do **not** update root badges/dates for release. +- Do **not** run release preparation steps. + ## Workflow 1. Identify changed READMEs. 2. Copy content to corresponding mirror paths. 3. Update version badges in `docs/plugins/{type}/index.md`. + +## Commands + +### Sync all mirrors (EN + ZH) + +```bash +python .github/skills/doc-mirror-sync/scripts/sync.py +``` + +### Sync only one plugin (EN only) + +```bash +cp plugins///README.md docs/plugins//.md +``` + +### Sync only one plugin (EN + ZH) + +```bash +cp plugins///README.md docs/plugins//.md +cp plugins///README_CN.md docs/plugins//.zh.md +``` + +## Notes + +- If asked for English-only update, sync only `README.md` -> `.md` mirror. +- If both languages are requested, sync both `README.md` and `README_CN.md`. +- After syncing, verify git diff only contains docs file changes. diff --git a/.github/skills/doc-mirror-sync/SKILL.md b/.github/skills/doc-mirror-sync/SKILL.md index eabac26..c83492e 100644 --- a/.github/skills/doc-mirror-sync/SKILL.md +++ b/.github/skills/doc-mirror-sync/SKILL.md @@ -8,7 +8,43 @@ description: Automatically synchronizes plugin READMEs to the official documenta ## Overview Automates the mirroring of `plugins/{type}/{name}/README.md` to `docs/plugins/{type}/{name}.md`. +## Docs-Only Mode (No Release Changes) +Use this mode when the request is "only sync docs". + +- Only update documentation mirror files under `docs/plugins/**`. +- Do **not** bump plugin version. +- Do **not** modify plugin code (`plugins/**.py`) unless explicitly requested. +- Do **not** update root badges/dates for release. +- Do **not** run release preparation steps. + ## Workflow 1. Identify changed READMEs. 2. Copy content to corresponding mirror paths. 3. Update version badges in `docs/plugins/{type}/index.md`. + +## Commands + +### Sync all mirrors (EN + ZH) + +```bash +python .github/skills/doc-mirror-sync/scripts/sync.py +``` + +### Sync only one plugin (EN only) + +```bash +cp plugins///README.md docs/plugins//.md +``` + +### Sync only one plugin (EN + ZH) + +```bash +cp plugins///README.md docs/plugins//.md +cp plugins///README_CN.md docs/plugins//.zh.md +``` + +## Notes + +- If asked for English-only update, sync only `README.md` -> `.md` mirror. +- If both languages are requested, sync both `README.md` and `README_CN.md`. +- After syncing, verify git diff only contains docs file changes.