Skip to content

docs(catalog): format Manifest v2 metadata as scannable list across skill docs - #462

Merged
rosspeili merged 1 commit into
ARPAHLS:mainfrom
rin-katsuragi:docs/format-catalog-taxonomy-metadata
Oct 31, 2026
Merged

rosspeili merged 1 commit into
ARPAHLS:mainfrom
rin-katsuragi:docs/format-catalog-taxonomy-metadata

Conversation

@rin-katsuragi

Copy link
Copy Markdown
Contributor

Fixes #448

Summary of Changes

In GitHub Flavored Markdown (GFM), consecutive non-empty lines without list indicators or double trailing spaces collapse into a single run-on paragraph. Because each skill catalog page's <!-- skill-doc-meta:begin --> block previously lacked list markers, GitHub rendered the Manifest v2 metadata (Version, Tier, Shape, Target, Tags) as a single cluttered horizontal line.

This PR:

  1. Catalog Documentation Formatting: Updates the <!-- skill-doc-meta:begin --> ... <!-- skill-doc-meta:end --> metadata blocks to a clean, scannable bulleted list (- **Version**: ..., - **Tier**: ..., - **Shape**: ..., - **Target**: ..., - **Tags**: ...) across all 28 skill catalog pages under docs/skills/ (including newly introduced bio/sequence_ops.md).
  2. Template & Authoring Standards: Updates docs/usage/skill_usage_template.md and CONTRIBUTING.md (§6) so future skill documentation follows the bulleted list convention.
  3. Changelog: Documents the change under ## [Unreleased] -> ### Changed in CHANGELOG.md.

Acceptance Criteria Mapping

Acceptance Criterion Implementation / Diff
Format Manifest v2 metadata cleanly without horizontal collapse Converted all 28 skill pages under docs/skills/*/*.md to bulleted list (- **Field**: ...)
Update authoring template for future skills Updated docs/usage/skill_usage_template.md & CONTRIBUTING.md
Maintain existing test suite compatibility pytest tests/test_registry_docs.py (20/20 passed)
Preserve skill history tables untouched No commit history rows or extraneous sections modified
Changelog documentation Updated CHANGELOG.md under [Unreleased] -> ### Changed referencing #448

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 (Fixes #448)
  • 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 pass locally
  • pytest tests/ passes locally when relevant
  • CHANGELOG.md updated under [Unreleased] when user-visible behavior changes
  • examples/README.md updated if this PR adds, renames, or removes a runnable script (N/A)
  • Ran pytest tests/test_registry_docs.py when skills, examples index, or agent-loops matrix changed
  • Ran pytest tests/test_skill_docs.py when catalog Usage Examples or provider snippets changed

Related Issues

Fixes #448

@rosspeili rosspeili left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This LGTM @rin-katsuragi. Thanks a lot! Merging as is. <3

@rosspeili
rosspeili merged commit 8a57c14 into ARPAHLS:main Oct 31, 2026
7 checks passed
@rin-katsuragi
rin-katsuragi deleted the docs/format-catalog-taxonomy-metadata branch October 31, 2026 09:25
@rin-katsuragi

Copy link
Copy Markdown
Contributor Author

Thank you for the fast review, trust in this and approval @rosspeili!

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.

[Docs]: Format skill catalog Manifest v2 metadata as a scannable list or table

2 participants