fix: add missing YAML frontmatter to ship reference docs#182
Open
xiaolai wants to merge 1 commit intoComposioHQ:masterfrom
Open
fix: add missing YAML frontmatter to ship reference docs#182xiaolai wants to merge 1 commit intoComposioHQ:masterfrom
xiaolai wants to merge 1 commit intoComposioHQ:masterfrom
Conversation
Claude Code requires YAML frontmatter with at least a `description` field to register command files. The three ship reference docs (ship-deployment, ship-ci-review-loop, ship-error-handling) were missing frontmatter entirely, causing Claude Code to fail to describe them while potentially enumerating them as commands. Added minimal frontmatter marking them as internal reference docs with `allowed-tools: []`. Co-Authored-By: Claude Code <noreply@anthropic.com>
This was referenced Apr 21, 2026
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
1 participant
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.
Bug
Three reference command files in the
ship/plugin were missing YAML frontmatter entirely:ship/commands/ship-deployment.mdship/commands/ship-ci-review-loop.mdship/commands/ship-error-handling.mdClaude Code requires a YAML frontmatter block (with at minimum a
descriptionfield) to register and describe command files. Without it, Claude Code may enumerate these files as commands but cannot describe them, and standalone invocation fails silently. The parentship.mdcorrectly references these as sub-documents, but the missing frontmatter creates ambiguity for the runtime.Fix
Added minimal YAML frontmatter to each file:
The
allowed-tools: []explicitly marks these as internal reference documents that don't need direct tool access (the parentship.mddeclares the full tool budget). The descriptions clarify their role as sub-documents referenced by/ship.Impact
Without this fix, users who attempt to invoke these files directly (e.g.,
/ship-deployment) get no useful feedback. The frontmatter makes Claude Code's behavior deterministic for these files.