Skip to content

docs(catalog): backfill Manifest v2 taxonomy to skill docs and add shape column to library index - #446

Merged
rosspeili merged 1 commit into
mainfrom
docs/catalog-taxonomy-meta-and-shape-column
Oct 20, 2026
Merged

rosspeili merged 1 commit into
mainfrom
docs/catalog-taxonomy-meta-and-shape-column

Conversation

@rosspeili

Copy link
Copy Markdown
Contributor

Description

Backfills Manifest v2 taxonomy metadata across all skill documentation pages and updates the high-level skill library index to expose execution shapes directly.

Following the merge of Manifest v2 taxonomy (#440), all 27 skill manifests declare tier, shape, target, and tags. This PR brings the documentation catalog, contributor guides, and CI doc assurance tests into 100% parity with the manifest schema.

Key Changes

  1. Skill Library Index (docs/skills/README.md):
    • Removed the redundant inline ## Universal Skill Taxonomy (Manifest v2) section to keep the library index clean.
    • Added a dedicated Shape column (atomic, workflow, middleware, stream) across all 12 category tables.
    • Updated introductory notes and footer navigation to link directly to runtime taxonomy filtering in agent_loops.md, CLI taxonomy flags in cli.md, and Manifest v2 specifications in ai_native_workflow.md.
  2. Catalog Metadata Blocks (docs/skills/*/*.md):
    • Backfilled Manifest v2 taxonomy items (Tier, Shape, Target, Tags) into the <!-- skill-doc-meta:begin --> ... <!-- skill-doc-meta:end --> block across all 27 individual skill catalog pages.
    • Values are strictly synchronized with each skill's manifest.yaml.
  3. Contributor Documentation (CONTRIBUTING.md, docs/usage/skill_usage_template.md):
    • Updated CONTRIBUTING.md §6 and §7 to document the Manifest v2 metadata markers in skill pages and the Shape column in docs/skills/README.md.
    • Updated docs/usage/skill_usage_template.md to guide contributors on formatting the taxonomy block inside skill-doc-meta.
  4. CI Doc Verification (tests/test_registry_docs.py):
    • Updated test_skill_library_index_has_version_and_shape_columns() to assert the new Shape column and verify that every manifest's shape is represented.
    • Updated test_catalog_pages_have_version_and_history_blocks() to enforce **Tier**:, **Shape**:, **Target**:, and **Tags**:.
    • Added test_catalog_pages_taxonomy_matches_manifests() to ensure CI detects any future divergence between doc metadata and manifest.yaml.

Type of Change

  • New Skill — new registry bundle under skills/
  • Skill Upgrade — changes to an existing skill under skills/
  • Bug Fix — incorrect runtime or framework behavior
  • Documentation — docs, README, CONTRIBUTING only
  • Framework Feature — skillware/core/ loader, env, adapters
  • CLI — skillware/cli.py, docs/usage/cli.md
  • Examples — examples/*.py, agent loops, examples/README.md
  • Packaging — PyPI wheel, pyproject.toml, MANIFEST.in
  • RFC / meta — templates, labels, CI, or large design doc

Checklist (all PRs)

  • Linked GitHub issue (Refs #440)
  • Scope matches the issue — no unrelated refactors
  • Contribution complies with Legal notice and code ownership (original work, MIT license grant, no malicious logic)
  • python -m black --check ., flake8, and ruff check . pass locally
  • pytest skills/ and pytest tests/ pass locally (1,155 passed, 0 failures)
  • CHANGELOG.md updated under [Unreleased] (documentation and test chore only; no runtime code or CLI changes)
  • examples/README.md updated if this PR adds, renames, or removes a runnable script
  • Ran pytest tests/test_registry_docs.py (20 passed)
  • Ran pytest tests/test_skill_docs.py (no provider snippets changed)

Related Issues

Refs #440

@rosspeili
rosspeili merged commit 85e41c7 into main Oct 20, 2026
7 checks passed
@rosspeili
rosspeili deleted the docs/catalog-taxonomy-meta-and-shape-column branch October 20, 2026 08:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant