Skip to content

docs: add glossary cross-links on hub and catalog pages - #364

Merged
rosspeili merged 6 commits into
ARPAHLS:mainfrom
HarshRajSinghania:docs/glossary-cross-links
Sep 21, 2026
Merged

rosspeili merged 6 commits into
ARPAHLS:mainfrom
HarshRajSinghania:docs/glossary-cross-links

Conversation

@HarshRajSinghania

Copy link
Copy Markdown
Contributor

Summary

Add one-hop links to docs/glossary.md on 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

  • Hub pages: docs/vision.md, docs/usage/README.md, docs/usage/agent_loops.md, docs/usage/skill_chaining.md now link the project glossary. The chaining page keeps its local host-orchestration glossary and points at the project one.
  • Catalog pages under docs/skills/*.md: append Vocabulary: [glossary](../glossary.md) next to the existing Skill anatomy link in Bundle layout. deck_builder.md had 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_glossary fails if those hubs or any docs/skills/*.md page omit glossary.md.

No API, manifest, or skill runtime changes.

Testing

Ran locally:

python3 -m pytest tests/test_registry_docs.py -q

Result: 13 passed.

@rosspeili

Copy link
Copy Markdown
Contributor

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, deck_builder section, and test_hub_and_catalog_pages_link_glossary all match the acceptance criteria. Docs-only, no CHANGELOG needed, but I would still add a short line in unreleased just for the audit trail.

Once you’ve claimed #363, short changelog line and CI is green, we’re good to merge. Welcome to Skillware <3

@HarshRajSinghania

Copy link
Copy Markdown
Contributor Author

Claimed #363. Added an Unreleased changelog line for the glossary cross-links.

@rosspeili

Copy link
Copy Markdown
Contributor

Thanks @HarshRajSinghania! This is a great doc-hygiene pass and the automated guard in tests/test_registry_docs.py prevents future drift.

Before we merge, please address these two quick items:

1. Fix Black & Flake8 whitespace in tests/test_registry_docs.py (CI Blocker)

Running python -m black --check . and flake8 currently fails on tests/test_registry_docs.py due to blank lines around test_hub_and_catalog_pages_link_glossary:

  • Line 292: 3 blank lines before the function (E303 too many blank lines (3) — needs 2).
  • Line 314: 1 blank line after the function (E302 expected 2 blank lines, found 1 — needs 2).

Running python -m black tests/test_registry_docs.py will fix both automatically:

python -m black tests/test_registry_docs.py
python -m flake8 tests/test_registry_docs.py

2. Fix phantom heading reference in docs/skills/deck_builder.md

In docs/skills/deck_builder.md, line 19 references a non-existent heading:
start markdown
The skill lives in skills/creative/deck_builder/. Skill anatomy. Vocabulary: glossary. Contract — see Manifest Details below. Assurance — test_skill.py in the bundle.
end markdown

Since deck_builder.md does not have a ## Manifest Details section, please align the wording with other catalog pages:
start markdown
The skill lives in skills/creative/deck_builder/. Skill anatomy. Vocabulary: glossary. Contract — manifest in the bundle. Assurance — test_skill.py in the bundle.
end markdown

3. Minor CHANGELOG polish

In CHANGELOG.md, please trim "the":
start markdown

Once Black formatting and the deck_builder wording fix are pushed, we'll merge!

@HarshRajSinghania

Copy link
Copy Markdown
Contributor Author

Thanks @rosspeili — addressed the three review items:

  1. tests/test_registry_docs.py: collapsed the extra blank line before test_hub_and_catalog_pages_link_glossary and added the second blank line after it (E303 / E302).
  2. docs/skills/deck_builder.md: replaced the phantom “see Manifest Details below” wording with “Contract — manifest in the bundle.”
  3. CHANGELOG.md: trimmed “the” from the Unreleased glossary line.

Pushed on this branch in 5a46dd9.

@rosspeili

Copy link
Copy Markdown
Contributor

Thanks @HarshRajSinghania, LGTM, nice first contribution and welcome to Skillware <3

@rosspeili
rosspeili merged commit 9040301 into ARPAHLS:main Sep 21, 2026
6 checks passed
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]: backfill glossary cross-links after #252 terminology sweep

2 participants