Skip to content

docs(command-development): clarify model field accepts full model strings#57

Merged
sjnims merged 2 commits intomainfrom
docs/49-clarify-model-field-accepts-full-model-strings
Dec 8, 2025
Merged

docs(command-development): clarify model field accepts full model strings#57
sjnims merged 2 commits intomainfrom
docs/49-clarify-model-field-accepts-full-model-strings

Conversation

@sjnims
Copy link
Copy Markdown
Owner

@sjnims sjnims commented Dec 8, 2025

Summary

Clarifies that the model frontmatter field in slash commands accepts both shorthand values and full model IDs.

Problem

Fixes #49

The command-development skill documentation only showed shorthand model values (sonnet, opus, haiku), but official Claude docs show full model IDs are also valid. This caused potential confusion about accepted formats.

Solution

Updated documentation to explicitly show both formats:

  • Shorthand: sonnet, opus, haiku
  • Full model ID: claude-sonnet-4-5-20250929, claude-haiku-4-5-20251001, etc.

Added clarification that shorthand names use the current default version of each model family.

Alternatives Considered

  • Only update the reference file: Decided to update both SKILL.md and frontmatter-reference.md for consistency
  • Use older model IDs from the issue: Updated to use current 4.5 model IDs (as of December 2025)

Changes

  • skills/command-development/references/frontmatter-reference.md: Updated model field values and validation fix text
  • skills/command-development/SKILL.md: Updated model field type and values

Testing

  • Linting passes (markdownlint)
  • Documentation is accurate per official Claude docs

🤖 Generated with Claude Code

…ings

Update documentation to clarify that the model frontmatter field accepts
both shorthand values (sonnet, opus, haiku) and full model IDs
(e.g., claude-sonnet-4-5-20250929, claude-haiku-4-5-20251001). Shorthand
names use the current default version of each model family.

Fixes #49

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@claude
Copy link
Copy Markdown

claude bot commented Dec 8, 2025

Claude finished @sjnims's task —— View job


PR Review: Clarify Model Field Documentation

Reviewing PR #57: docs(command-development): clarify model field accepts full model strings

Summary

✅ Looks good - This PR effectively addresses issue #49 by clarifying that the model frontmatter field accepts both shorthand and full model ID formats.


What's Good

  1. Accurate and Comprehensive: Both files (SKILL.md and frontmatter-reference.md) are consistently updated with the same information, maintaining documentation coherence.

  2. Clear Format Examples: The PR provides concrete examples:

    • Shorthand: sonnet, opus, haiku
    • Full model IDs: claude-sonnet-4-5-20250929, claude-haiku-4-5-20251001
  3. Important Clarification Added: The note "Shorthand names use the current default version of each model family" helps users understand the relationship between shorthand and full IDs.

  4. Validation Fix Updated: The error message in the validation section was appropriately updated to show both accepted formats (line 448 in frontmatter-reference.md).

  5. Clean Changes: Minimal, focused diff that addresses exactly what was needed without scope creep.

  6. Markdown Linting: All markdown files pass markdownlint validation with no errors.


Suggestions

No significant issues found. The documentation changes are accurate, well-structured, and follow the existing documentation patterns.

Minor consideration (optional, not required):

  • The examples use specific model IDs like claude-sonnet-4-5-20250929. While these are current as of December 2025, consider that model IDs may evolve. The examples are fine as-is since they demonstrate the format, and the text "etc." appropriately indicates these are examples rather than an exhaustive list.

Checklist Verification

  • Plugin component structure: Skill documentation follows proper format with frontmatter
  • Markdown quality: No linting errors detected
  • Consistency: Both SKILL.md and frontmatter-reference.md updated consistently
  • Accuracy: Information aligns with official Claude documentation
  • User-facing impact: Changes improve clarity without breaking existing usage

Recommendation: ✅ Approve and merge

This PR successfully resolves issue #49 by documenting both accepted formats for the model field, improving the developer experience for command creation.


@claude claude bot added documentation Improvements or additions to documentation component:skill Skills layer effort:small < 1 hour labels Dec 8, 2025
…ial docs URL

Add blockquote note directing readers to official Claude docs for current
model IDs, since model names evolve with new releases.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@sjnims
Copy link
Copy Markdown
Owner Author

sjnims commented Dec 8, 2025

Addressed the review suggestion about model ID currency:

Added a blockquote note to frontmatter-reference.md that:

  1. States the examples reflect December 2025 releases
  2. Notes that Anthropic releases new model versions periodically
  3. Points to official docs URL for current model IDs

This makes the documentation evergreen - when Claude loads this skill, it can reference the official docs for the most up-to-date model names rather than relying on potentially stale examples.

> **Note:** Model ID examples above reflect December 2025 releases. Anthropic releases new model versions periodically. For current model IDs, consult [Claude Models Overview](https://docs.anthropic.com/en/docs/about-claude/models).

@claude
Copy link
Copy Markdown

claude bot commented Dec 8, 2025

Claude finished @sjnims's task —— View job


PR Review: Model Field Documentation Update

Reviewing PR #57: docs(command-development): clarify model field accepts full model strings


Summary

✅ Excellent update - This PR effectively addresses issue #49 and includes a thoughtful improvement based on previous review feedback. The documentation now clearly shows both shorthand and full model ID formats, with an evergreen note directing users to official docs for current model IDs.


What's Good

  1. Comprehensive Format Coverage: Both files consistently document both accepted formats:

    • Shorthand: sonnet, opus, haiku
    • Full model IDs: claude-sonnet-4-5-20250929, claude-haiku-4-5-20251001
  2. Excellent Evergreen Documentation: The added blockquote in frontmatter-reference.md (lines 142-143) is a smart addition that:

    • Acknowledges examples are current as of December 2025
    • Notes that model versions change periodically
    • Provides official docs URL for current model IDs
    • Makes the documentation future-proof
  3. Critical Clarification Added: "Shorthand names use the current default version of each model family" helps users understand the relationship between formats (SKILL.md:174, frontmatter-reference.md:140).

  4. Validation Section Updated: The error message fix in frontmatter-reference.md:450 now shows both accepted formats, improving developer experience when debugging.

  5. Clean, Focused Changes: The diff is minimal (+13/-3) and addresses exactly what was needed without scope creep.

  6. Markdown Quality: All linting passes with no errors ✅


Suggestions

None - This PR is ready to merge. The documentation is accurate, well-structured, consistent across both files, and includes forward-thinking documentation practices.


Checklist Verification

  • Plugin component structure: Skill documentation follows proper format with valid frontmatter
  • Markdown quality: No linting errors detected (markdownlint passed cleanly)
  • Consistency: Both SKILL.md and frontmatter-reference.md updated with matching information
  • Accuracy: Information aligns with official Claude documentation
  • User-facing impact: Changes improve clarity without breaking existing usage
  • Evergreen documentation: Includes reference to official docs for future model updates

Recommendation: ✅ Approve and merge immediately

This PR successfully resolves issue #49 and demonstrates excellent documentation practices with the evergreen note. The addition based on the previous review feedback shows thoughtful consideration for long-term documentation maintenance.


@sjnims sjnims merged commit 03f2cb4 into main Dec 8, 2025
7 checks passed
@sjnims sjnims deleted the docs/49-clarify-model-field-accepts-full-model-strings branch December 8, 2025 22:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component:skill Skills layer documentation Improvements or additions to documentation effort:small < 1 hour

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(command-development): clarify model field accepts full model strings

1 participant