docs: add glossary cross-links on hub and catalog pages - #364
Conversation
|
Hey @HarshRajSinghania, thanks for picking up #363, and from what I see this is a clean PR. Process first: please comment on #363 with a short claim before we merge. We ask everyone to do that on assigned/good-first issues so work doesn’t collide. CONTRIBUTING — Pull request process. Review: Overall implementation looks good — hub links, catalog Bundle layout lines, Once you’ve claimed #363, short changelog line and CI is green, we’re good to merge. Welcome to Skillware <3 |
|
Claimed #363. Added an Unreleased changelog line for the glossary cross-links. |
|
Thanks @HarshRajSinghania! This is a great doc-hygiene pass and the automated guard in Before we merge, please address these two quick items: 1. Fix Black & Flake8 whitespace in
|
|
Thanks @rosspeili — addressed the three review items:
Pushed on this branch in |
|
Thanks @HarshRajSinghania, LGTM, nice first contribution and welcome to Skillware <3 |
Summary
Add one-hop links to
docs/glossary.mdon high-traffic hub pages and every skill catalog page so readers land on canonical role/anatomy terms after the #252 terminology sweep.Motivation
Fixes #363. After #362 landed the glossary, several hubs and most catalog pages still had no link to it. Contributors could keep using pre-glossary vocabulary without a single hop to the canonical table.
Implementation
docs/vision.md,docs/usage/README.md,docs/usage/agent_loops.md,docs/usage/skill_chaining.mdnow link the project glossary. The chaining page keeps its local host-orchestration glossary and points at the project one.docs/skills/*.md: appendVocabulary: [glossary](../glossary.md)next to the existing Skill anatomy link in Bundle layout.deck_builder.mdhad no Bundle layout section, so one was added to match the other catalog pages.tests/test_registry_docs.py:test_hub_and_catalog_pages_link_glossaryfails if those hubs or anydocs/skills/*.mdpage omitglossary.md.No API, manifest, or skill runtime changes.
Testing
Ran locally:
Result: 13 passed.