refactor: standardize skill documentation on references/ layout - #156
Open
rhartuv wants to merge 2 commits into
Open
refactor: standardize skill documentation on references/ layout#156rhartuv wants to merge 2 commits into
rhartuv wants to merge 2 commits into
Conversation
rhartuv
marked this pull request as ready for review
September 8, 2026 09:22
rhartuv
requested review from
TomerFi,
dmartinol,
ikrispin,
nemerna and
r2dedios
as code owners
September 8, 2026 09:22
rhartuv
marked this pull request as draft
September 8, 2026 09:27
rhartuv
marked this pull request as ready for review
September 8, 2026 09:42
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.
Refactor: Standardize skill documentation on
references/layout and consolidate Compass validationSummary
This PR migrates agentic pack skills from the legacy
docs/convention to the agent-plugins.orgreferences/layout, removes leftover duplicate directories, flattens accidentalreferences/references/nesting, and consolidates validation so regressions are caught in CI.Jira ticket
Motivation
Skill-local documentation must live under
references/, notdocs/. The olddocs/references/structure caused double-nestedreferences/references/folders after migration. Pack-leveldocs/duplicates also lingered afterreferences/was introduced.Changes
Documentation migration (all packs)
skills/<name>/docs/→skills/<name>/references/across 46+ skillsdocs/directories after migrationdocs/trees (ocp-admin,rh-sre,rh-virt,rh-automation) wherereferences/already existeddocs/...toreferences/...(including./references/form inSKILL.md)references/references/directories intoskills/<name>/references/Validation (single entry point)
scripts/validate_compass_manifests.pyto enforce:skills/<name>/docs/references/references/nestingdocs/markdown linksreferences/symlinks targetingdocs/pathsscripts/validate_skill_references_layout.py(merged into compass validation)validate_skill_doc_links.pyto acceptreferences/...and./references/...validate_docs_tree_links.pyto scanskills/*/references/**/*.mdAuthoring standards
SKILL_DESIGN_PRINCIPLES.md— requiresreferences/, forbids nestedreferences/references/, documents symlink pool link rulescompass-manifest-maintenanceskill — workflow to scan, migrate, flatten, deletedocs/, fix symlinks, validate viamake validate-compass-manifestsagentic-contribution-skill— createsreferences/, notdocs/.catalog/collection.yamlembedded_doc paths updatedNote for Reviewers:
Due to file relocation, this PR touches ~700 files. Most changes are path updates and moved files.
Test plan
make validatepasses locallyuv run python scripts/validate_skill_doc_links.py— passes (70 skills, 388 reference links)uv run python scripts/validate_docs_tree_links.py— passes (444 files)skills/*/docs/directories remainskills/*/references/references/directories remainname,description)name,description)