|
| 1 | +--- |
| 2 | +description: Update all the documentation related files. |
| 3 | +--- |
| 4 | + |
| 5 | +After completing any skill creation, agent creation, or command creation in this repository, run the full post-creation sync pipeline below. Execute every step — never skip a task. If something is unclear or a step fails, ask the user for guidance before continuing. |
| 6 | + |
| 7 | +--- |
| 8 | + |
| 9 | +## Step 1: Inventory what changed |
| 10 | + |
| 11 | +Scan the working tree to identify what was added, modified, or deleted: |
| 12 | + |
| 13 | +```bash |
| 14 | +git status --short |
| 15 | +``` |
| 16 | + |
| 17 | +Classify each change: |
| 18 | +- **New skill** — a new folder containing `SKILL.md` under a domain directory |
| 19 | +- **New agent** — a new `.md` file under `agents/` |
| 20 | +- **New command** — a new `.md` file under `commands/` |
| 21 | +- **Modified skill/agent/command** — updated existing files |
| 22 | +- **Deleted skill/agent/command** — removed files |
| 23 | + |
| 24 | +Report the inventory to the user before proceeding. |
| 25 | + |
| 26 | +--- |
| 27 | + |
| 28 | +## Step 2: Cross-platform CLI sync |
| 29 | + |
| 30 | +Ensure all platforms have compatible versions of every skill, agent, and command. |
| 31 | + |
| 32 | +### 2a. Codex CLI |
| 33 | + |
| 34 | +Run the Codex sync script to regenerate symlinks and the skills index: |
| 35 | + |
| 36 | +```bash |
| 37 | +python3 scripts/sync-codex-skills.py --verbose |
| 38 | +``` |
| 39 | + |
| 40 | +Verify the output: check `.codex/skills-index.json` for correct `total_skills` count and that new skills appear in the index. |
| 41 | + |
| 42 | +### 2b. Gemini CLI |
| 43 | + |
| 44 | +Run the Gemini sync script: |
| 45 | + |
| 46 | +```bash |
| 47 | +python3 scripts/sync-gemini-skills.py --verbose |
| 48 | +``` |
| 49 | + |
| 50 | +Verify: check `.gemini/skills-index.json` for correct total count. New skills, agents, and commands should all have corresponding entries and symlinks under `.gemini/skills/`. |
| 51 | + |
| 52 | +### 2c. OpenClaw |
| 53 | + |
| 54 | +Verify that `scripts/openclaw-install.sh` will pick up the new skills. The install script uses the same directory structure, so no separate sync is needed — but confirm the new skill directories are not excluded by any filter in the script. |
| 55 | + |
| 56 | +Report sync results (skill counts per platform) to the user. |
| 57 | + |
| 58 | +--- |
| 59 | + |
| 60 | +## Step 3: Claude Code plugin marketplace |
| 61 | + |
| 62 | +### 3a. Domain-level plugin.json |
| 63 | + |
| 64 | +For each domain that had changes, update the domain's `.claude-plugin/plugin.json`: |
| 65 | +- Update `description` with accurate skill/tool/reference counts |
| 66 | +- Update `version` if needed |
| 67 | +- Verify `source` paths are correct |
| 68 | + |
| 69 | +Domain plugin.json locations: |
| 70 | +- `marketing-skill/.claude-plugin/plugin.json` |
| 71 | +- `engineering-team/.claude-plugin/plugin.json` |
| 72 | +- `engineering/.claude-plugin/plugin.json` |
| 73 | +- `product-team/.claude-plugin/plugin.json` |
| 74 | +- `c-level-advisor/.claude-plugin/plugin.json` |
| 75 | +- `project-management/.claude-plugin/plugin.json` |
| 76 | +- `ra-qm-team/.claude-plugin/plugin.json` |
| 77 | +- `business-growth/.claude-plugin/plugin.json` |
| 78 | +- `finance/.claude-plugin/plugin.json` |
| 79 | + |
| 80 | +### 3b. Root marketplace.json |
| 81 | + |
| 82 | +Update `.claude-plugin/marketplace.json`: |
| 83 | +- Update the top-level `metadata.description` with accurate total counts (skills, tools, references, agents, commands) |
| 84 | +- If a new individual skill plugin entry is needed (for standalone install), add it to the `plugins` array following the existing pattern |
| 85 | +- Update `keywords` arrays if new domains or capabilities were added |
| 86 | +- Verify all `source` paths point to valid directories |
| 87 | + |
| 88 | +--- |
| 89 | + |
| 90 | +## Step 4: Update documentation files |
| 91 | + |
| 92 | +### 4a. Root CLAUDE.md |
| 93 | + |
| 94 | +Update `/CLAUDE.md` (the root project instructions): |
| 95 | +- **Current Scope** line: update skill, tool, reference, agent, and command counts |
| 96 | +- **Repository Structure** comment counts (agents, commands, skills per domain) |
| 97 | +- **Navigation Map** table: verify all domain entries are current |
| 98 | +- **Current Version** section: add a bullet if significant changes were made |
| 99 | +- **Roadmap** section: update counts if needed |
| 100 | + |
| 101 | +### 4b. Domain-level CLAUDE.md files |
| 102 | + |
| 103 | +For each domain that had changes, update its `CLAUDE.md`: |
| 104 | +- Skill count and list |
| 105 | +- Script/tool count |
| 106 | +- Agent references |
| 107 | +- Command references |
| 108 | +- Any new cross-domain integrations |
| 109 | + |
| 110 | +Domain CLAUDE.md locations: |
| 111 | +- `agents/CLAUDE.md` |
| 112 | +- `marketing-skill/CLAUDE.md` |
| 113 | +- `product-team/CLAUDE.md` |
| 114 | +- `engineering-team/CLAUDE.md` |
| 115 | +- `c-level-advisor/CLAUDE.md` |
| 116 | +- `project-management/CLAUDE.md` |
| 117 | +- `ra-qm-team/CLAUDE.md` |
| 118 | +- `business-growth/CLAUDE.md` |
| 119 | +- `finance/CLAUDE.md` |
| 120 | +- `standards/CLAUDE.md` |
| 121 | +- `templates/CLAUDE.md` |
| 122 | + |
| 123 | +### 4c. Root README.md |
| 124 | + |
| 125 | +Update `/README.md`: |
| 126 | +- Badge counts (Skills, Agents, Commands) |
| 127 | +- Tagline/intro paragraph skill count |
| 128 | +- Skills Overview table (domain rows with correct counts) |
| 129 | +- Quick Install section (install commands, skill counts in comments) |
| 130 | +- Python Analysis Tools section (tool count, add examples for new tools) |
| 131 | +- FAQ section (update any counts mentioned) |
| 132 | + |
| 133 | +### 4d. docs/index.md (GitHub Pages homepage) |
| 134 | + |
| 135 | +Update `docs/index.md`: |
| 136 | +- `description` meta tag |
| 137 | +- Hero subtitle skill count |
| 138 | +- Grid cards (skills, tools, agents, commands counts) |
| 139 | +- Domain cards (skill counts per domain, links) |
| 140 | + |
| 141 | +### 4e. docs/getting-started.md |
| 142 | + |
| 143 | +Update `docs/getting-started.md`: |
| 144 | +- `description` meta tag |
| 145 | +- Available Bundles table (skill counts per bundle) |
| 146 | +- Python Tools section (tool count) |
| 147 | +- FAQ answers (any count references) |
| 148 | + |
| 149 | +--- |
| 150 | + |
| 151 | +## Step 5: Regenerate GitHub Pages |
| 152 | + |
| 153 | +Run the docs generation script to create/update all MkDocs pages: |
| 154 | + |
| 155 | +```bash |
| 156 | +python3 scripts/generate-docs.py |
| 157 | +``` |
| 158 | + |
| 159 | +This generates pages for: |
| 160 | +- Every skill (from SKILL.md files) |
| 161 | +- Every agent (from agents/*.md) |
| 162 | +- Every command (from commands/*.md) |
| 163 | +- Index pages for skills, agents, and commands sections |
| 164 | + |
| 165 | +### 5a. Update mkdocs.yml navigation |
| 166 | + |
| 167 | +Open `mkdocs.yml` and update the `nav:` section: |
| 168 | +- Add new skill pages under the correct domain section |
| 169 | +- Add new agent pages under the Agents section |
| 170 | +- Add new command pages under the Commands section |
| 171 | +- Update `site_description` with current counts |
| 172 | + |
| 173 | +### 5b. Verify the build |
| 174 | + |
| 175 | +```bash |
| 176 | +python3 -m mkdocs build 2>&1 | tail -5 |
| 177 | +``` |
| 178 | + |
| 179 | +The build should complete without errors. Warnings about relative links in SKILL.md files are expected and can be ignored (they reference skill-internal paths like `references/` and `scripts/`). |
| 180 | + |
| 181 | +Report the build result and page count to the user. |
| 182 | + |
| 183 | +--- |
| 184 | + |
| 185 | +## Step 6: Consistency verification |
| 186 | + |
| 187 | +Run a final consistency check across all updated files: |
| 188 | + |
| 189 | +1. **Count consistency** — Verify the same skill/agent/command/tool counts appear in: |
| 190 | + - Root CLAUDE.md |
| 191 | + - Root README.md |
| 192 | + - docs/index.md |
| 193 | + - docs/getting-started.md |
| 194 | + - .claude-plugin/marketplace.json |
| 195 | + |
| 196 | +2. **Path validation** — Verify all `source` paths in marketplace.json point to existing directories |
| 197 | + |
| 198 | +3. **New script verification** — If new Python scripts were added, verify they run: |
| 199 | + ```bash |
| 200 | + python3 path/to/new/script.py --help |
| 201 | + ``` |
| 202 | + |
| 203 | +4. **Frontmatter check** — Verify all new SKILL.md, agent, and command files have valid YAML frontmatter with at minimum `name` and `description` fields |
| 204 | + |
| 205 | +Report any inconsistencies found and fix them before finishing. |
| 206 | + |
| 207 | +--- |
| 208 | + |
| 209 | +## Step 7: Summary report |
| 210 | + |
| 211 | +Present a summary to the user: |
| 212 | + |
| 213 | +| Item | Status | |
| 214 | +|------|--------| |
| 215 | +| New skills added | [list] | |
| 216 | +| New agents added | [list] | |
| 217 | +| New commands added | [list] | |
| 218 | +| Codex CLI sync | count | |
| 219 | +| Gemini CLI sync | count | |
| 220 | +| OpenClaw compatible | yes/no | |
| 221 | +| Marketplace updated | yes/no | |
| 222 | +| CLAUDE.md files updated | [count]/[total] | |
| 223 | +| README.md updated | yes/no | |
| 224 | +| GitHub Pages regenerated | [page count] pages | |
| 225 | +| MkDocs build | pass/fail | |
| 226 | +| Consistency check | pass/fail | |
| 227 | + |
| 228 | +Ask the user if they want to commit and push the changes. |
0 commit comments