Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -413,7 +413,7 @@ Registry skills are shipped inside the `skillware` wheel. Per-skill layout uses
### 6. `docs/skills/<category>/<skill_name>.md` (catalog page)

- Human-readable documentation linked from the [Skill Library](docs/skills/README.md) and the category hub `docs/skills/<category>/README.md`.
- Include **ID**, **Issuer**, **Version** (from `manifest.yaml`), and **Recommended install** (`pip install "skillware[<category>_<skill>]"` — see [install_extras.md](install_extras.md)) near the top.
- Include **ID**, **Issuer**, the Manifest v2 metadata block (**Version**, **Tier**, **Shape**, **Target**, **Tags** inside `<!-- skill-doc-meta:begin --> ... <!-- skill-doc-meta:end -->`), and **Recommended install** (`pip install "skillware[<category>_<skill>]"` — see [install_extras.md](install_extras.md)) near the top.
- Include the **intent** block (`<!-- skill-intent:begin -->`) with **Solves**, **Works with**, and **Runtime** lines so search and GitHub can match operator queries. Keep wording accurate; do not stuff keywords.
- Describe capabilities, prerequisites, arguments, and limitations.
- If the skill calls external services, list its environment variables in a short table and link to [API keys for skills](docs/usage/api_keys.md). Do not duplicate the full setup guide on the skill page.
Expand All @@ -425,7 +425,7 @@ Do **not** add `skills/<category>/README.md` inside the runtime registry. Catego

### 7. Registry index row

- Add or update the skill table in `docs/skills/<category>/README.md` **and** [docs/skills/README.md](docs/skills/README.md) (Skill, ID, Version, Issuer, Description). Set **Version** to `` `x.y.z` (DD Mon YYYY) `` from the manifest and the release/merge date.
- Add or update the skill table in `docs/skills/<category>/README.md` (Skill, ID, Version, Issuer, Description) **and** [docs/skills/README.md](docs/skills/README.md) (Skill, ID, Shape, Version, Issuer, Description). Set **Version** to `` `x.y.z` (DD Mon YYYY) `` from the manifest and the release/merge date.
- Add the catalog page and hub to [docs/sitemap.md](docs/sitemap.md).
- New top-level category: also add a row to the root README category table and a hub at `docs/skills/<category>/README.md`.

Expand Down
4 changes: 2 additions & 2 deletions docs/contributing/ai_native_workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ These align with [CONTRIBUTING.md](../../CONTRIBUTING.md). Violations block merg
- `issuer.name` and `issuer.email` required; `github` and optional `org` per [Issuer org](../../CONTRIBUTING.md#issuer-org); no template placeholders in registry paths
- `card.json` issuer must match manifest `name` and `email` when present
- Output-card `ui_schema.fields[].key` values must resolve in `execute()` JSON; keep `tests/fixtures/card_ui_schema/<category>__<skill_name>.json` in sync (#199)
- Update `docs/skills/<category>/<skill_name>.md`, `docs/skills/<category>/README.md`, `docs/skills/README.md`, and `docs/sitemap.md` (**Version**, **Skill history**, intent block, and index columns per [CONTRIBUTING.md § catalog page](../../CONTRIBUTING.md#6-docsskillscategoryskill_namemd-catalog-page))
- Update `docs/skills/<category>/<skill_name>.md`, `docs/skills/<category>/README.md`, `docs/skills/README.md`, and `docs/sitemap.md` (Manifest v2 metadata block with **Version**, **Tier**, **Shape**, **Target**, **Tags**, **Skill history**, intent block, and index columns per [CONTRIBUTING.md § catalog page](../../CONTRIBUTING.md#6-docsskillscategoryskill_namemd-catalog-page))
- **Skill history audit:** The **Skill history** table on every catalog page must contain exact commit hashes, dates, release versions, and real contributor attribution. Never commit template placeholders or omit historical versions. Do not push piecemeal commit-link chores after every individual PR merge; maintainers sweep and reconcile squash-merge commit SHAs against `main` line-by-line as part of release bump chores when cutting a framework release. Verify history manually against `git log --oneline -- <skill_dir>` and `CHANGELOG.md`; never use automated batch scripts for documentation curation.
- On each catalog page, add a **Usage Examples** section (Gemini, Claude, OpenAI, DeepSeek, Ollama prompt mode) per [skill usage template](../usage/skill_usage_template.md). Keep provider mechanics in `docs/usage/`; put skill-specific paths, sample user messages, and `execute` payloads on the skill page.
- Categories: `compliance`, `creative`, `data_engineering`, `defi`, `dev_tools`, `finance`, `linguistics`, `monitoring`, `office`, `optimization`, `security`, `wellness` — see [Skill library](../skills/README.md) for the live registry; [Choosing a category](../../CONTRIBUTING.md#choosing-a-category) in CONTRIBUTING.md (issue first for new top-level folders)
Expand Down Expand Up @@ -293,7 +293,7 @@ Complete the checklist that matches your issue during Stage 5.
- [ ] `card.json` (Presentation): `issuer` matches manifest; output-card `ui_schema.fields[].key` paths resolve in `tests/fixtures/card_ui_schema/<category>__<skill_name>.json` (update fixture when `execute()` output changes)
- [ ] `test_skill.py` (Assurance) passes — `pytest skills/<category>/<skill_name>/test_skill.py` or `skillware test <category>/<skill_name>`
- [ ] Bundle tests mock all network calls and model downloads; CI does not download models.
- [ ] `docs/skills/<category>/<skill_name>.md`, category hub row, catalog row in `docs/skills/README.md`, and `docs/sitemap.md` (**Version** from manifest, **Skill history** with linked GitHub usernames, intent block, **Recommended install:** `pip install "skillware[<category>_<skill>]"` per [install_extras.md](../usage/install_extras.md))
- [ ] `docs/skills/<category>/<skill_name>.md`, category hub row (with `Version`), catalog row in `docs/skills/README.md` (with `Shape` and `Version`), and `docs/sitemap.md` (Manifest v2 metadata block with `Version`, `Tier`, `Shape`, `Target`, `Tags`, **Skill history** with linked GitHub usernames, intent block, **Recommended install:** `pip install "skillware[<category>_<skill>]"` per [install_extras.md](../usage/install_extras.md))
- [ ] After changing `manifest.yaml` `requirements`, run `python scripts/sync_extras.py` and confirm `python scripts/sync_extras.py --check` passes
- [ ] **Usage Examples** on the catalog page (all five providers per [skill usage template](../usage/skill_usage_template.md)); link to `docs/usage/` and list skill `env_vars` without duplicating [api_keys.md](../usage/api_keys.md)
- [ ] `pytest tests/test_skill_issuer.py` passes
Expand Down
Loading
Loading