|
1 | 1 | # Publishing and Distribution |
2 | 2 |
|
3 | | -## 1) Publish to GitHub |
| 3 | +## Publish to GitHub |
4 | 4 |
|
5 | 5 | From repository root: |
6 | 6 |
|
7 | 7 | ```bash |
8 | 8 | git add . |
9 | | -git commit -m "feat: add code-explainer skill" |
| 9 | +git commit -m "feat: rebuild code-explainer around grounded explanation quality" |
10 | 10 | git remote add origin https://github.com/<your-org-or-user>/code-explainer.git |
11 | 11 | git push -u origin main |
12 | 12 | ``` |
13 | 13 |
|
14 | | -## 2) Verify Install from GitHub |
| 14 | +## What To Verify Before Publishing |
15 | 15 |
|
16 | | -Use the Skills CLI install pattern: |
| 16 | +1. The repo-level docs match the shipped skill contract. |
| 17 | +2. `code-explainer/SKILL.md` reflects the current pipeline and proof path. |
| 18 | +3. `python code-explainer/scripts/self_audit.py` passes. |
| 19 | +4. `install_to_codex.ps1` installs the current package cleanly. |
| 20 | + |
| 21 | +Recommended: |
17 | 22 |
|
18 | 23 | ```bash |
19 | | -npx skills add https://github.com/baboonzero/code-explainer --skill code-explainer |
| 24 | +cd code-explainer |
| 25 | +python scripts/self_audit.py |
20 | 26 | ``` |
21 | 27 |
|
22 | | -Or with Codex system installer script: |
| 28 | +If you want a scored artifact before publishing, also run the local `audit-skill` against `code-explainer/`. |
23 | 29 |
|
24 | | -```bash |
25 | | -python ~/.codex/skills/.system/skill-installer/scripts/install-skill-from-github.py \ |
26 | | - --repo baboonzero/code-explainer \ |
27 | | - --path code-explainer |
| 30 | +## Install Verification |
| 31 | + |
| 32 | +Install locally into Codex: |
| 33 | + |
| 34 | +```powershell |
| 35 | +powershell -ExecutionPolicy Bypass -File .\install_to_codex.ps1 |
28 | 36 | ``` |
29 | 37 |
|
30 | | -Dependency note for downstream users: |
| 38 | +Then restart Codex and confirm the installed copy appears at: |
31 | 39 |
|
32 | | -- Python 3.10+ |
33 | | -- Node.js 18+ and npm |
| 40 | +```text |
| 41 | +~/.codex/skills/code-explainer |
| 42 | +``` |
| 43 | + |
| 44 | +## Downstream Dependency Note |
| 45 | + |
| 46 | +Users need: |
| 47 | + |
| 48 | +- Python `3.10+` |
| 49 | +- Node.js `18+` and npm |
34 | 50 | - Git |
35 | | -- Mermaid CLI (`@mermaid-js/mermaid-cli`) for full SVG/PNG rendering |
36 | 51 |
|
37 | | -Point users to: |
| 52 | +Recommended for full diagram rendering: |
| 53 | + |
| 54 | +- Mermaid CLI (`@mermaid-js/mermaid-cli`) |
38 | 55 |
|
39 | | -- `README.md` -> "Dependencies (Required for Skill Installation/Use)" |
40 | | -- `code-explainer/SKILL.md` -> "Dependencies" |
| 56 | +Even without live LLM access, the proof path still works through `CODE_EXPLAINER_MOCK_LLM=true`. |
41 | 57 |
|
42 | | -## 3) `skills.sh` Listing Expectations |
| 58 | +## GitHub Distribution |
| 59 | + |
| 60 | +Suggested install paths for other developers: |
| 61 | + |
| 62 | +Using the Skills CLI: |
| 63 | + |
| 64 | +```bash |
| 65 | +npx skills add https://github.com/<your-org-or-user>/code-explainer --skill code-explainer |
| 66 | +``` |
| 67 | + |
| 68 | +Using Codex system installer tooling: |
| 69 | + |
| 70 | +```bash |
| 71 | +python ~/.codex/skills/.system/skill-installer/scripts/install-skill-from-github.py \ |
| 72 | + --repo <your-org-or-user>/code-explainer \ |
| 73 | + --path code-explainer |
| 74 | +``` |
43 | 75 |
|
44 | | -- `skills.sh` tracks install activity from `npx skills` usage. |
45 | | -- The site updates roughly every 12 hours. |
46 | | -- Removed/unavailable repos can be pruned from listings. |
| 76 | +## Discoverability |
47 | 77 |
|
48 | | -Practical implication: |
| 78 | +Suggested GitHub topics: |
49 | 79 |
|
50 | | -1. Publish repo publicly. |
51 | | -2. Ensure install command works. |
52 | | -3. Have users install via `npx skills ...` so the skill becomes discoverable through ecosystem tracking. |
| 80 | +- `codex-skill` |
| 81 | +- `agent-skill` |
| 82 | +- `codebase-analysis` |
| 83 | +- `onboarding` |
| 84 | +- `mermaid` |
| 85 | +- `developer-tools` |
53 | 86 |
|
54 | | -## 4) Increase Discoverability |
| 87 | +Useful publishing assets: |
55 | 88 |
|
56 | | -1. Add GitHub topics: `agent-skill`, `codex`, `mermaid`, `codebase-analysis`, `onboarding`. |
57 | | -2. Add a short demo GIF in README showing generated overview + deep docs. |
58 | | -3. Publish a GitHub release with example outputs. |
59 | | -4. Share in developer communities with install command and sample output links. |
| 89 | +1. A short README section showing `overview/OVERVIEW.md` |
| 90 | +2. One example diagram image |
| 91 | +3. The self-audit result summary |
| 92 | +4. A release note that explains the rebuild from generic output to proof-backed output |
0 commit comments