feat(catalog): add README category index generation - #4
Merged
dddddddxl merged 1 commit intoAug 27, 2026
Merged
Conversation
Signed-off-by: tianlinyang77 <tianlinyang77@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Generate a category index in
README.mdso the catalog stays navigable as skills are added. Today the README lists skills by product only; once the catalog grows past roughly ten skills, a reader cannot tell which skill applies to their task without opening each one.categoryis already required incomponents.d/*.ymland already drivesskills.sh.jsongroupings, so this change reuses existing metadata rather than introducing a new field.What changed
scripts/generate_catalog.pyrenders a<!-- categories:start -->/<!-- categories:end -->section containing a skill/category count summary and one table per category.README.mdgains theSkills by categorysection and its markers.components.d/README.mddocuments thatcategorydrives the generated index, and asks contributors to reuse an existing category name when one fits.tests/test_skillhub.pycovers grouping, deterministic ordering, singular/plural labels, table escaping, and the missing-marker error.Output is deterministic: categories sort by lowercased name, skills sort by
catalog_dir, and pipes and newlines in descriptions are escaped.generate_catalog.py --checktherefore still detects drift.With the current single skill the section renders as:
Publication checks
HYGON-AI.Validation
python -m unittest discover -s tests— 8 tests passpython scripts/validate_skills.pypython scripts/generate_catalog.py --check