Skip to content

fix: add missing code block markers in agent Output Format sections#114

Merged
sjnims merged 1 commit intomainfrom
fix/111-missing-code-block-markers
Dec 11, 2025
Merged

fix: add missing code block markers in agent Output Format sections#114
sjnims merged 1 commit intomainfrom
fix/111-missing-code-block-markers

Conversation

@sjnims
Copy link
Copy Markdown
Owner

@sjnims sjnims commented Dec 11, 2025

Summary

Adds opening code block markers to the Output Format template sections in two agent files that were missing them, fixing markdown rendering issues.

Problem

Fixes #111

Two agent files (agent-creator.md and skill-reviewer.md) had Output Format sections with closing ``` markers but no opening markers. This caused the output templates to be rendered as actual markdown rather than displayed as code examples for the agent to follow.

Solution

Added opening ```markdown markers to properly wrap the Output Format template sections as code blocks.

Why This Approach

  • Minimal change: Only 2 lines added total (1 per file)
  • Pattern-consistent: Matches the properly-formatted code blocks in plugin-validator.md
  • Verifiable: markdownlint passes with no errors

Alternatives Considered

  1. Restructure entire Output Format sections - Rejected as over-engineering for a simple missing marker
  2. Remove closing markers instead - Would lose the template formatting entirely

Changes

File Change
plugins/plugin-dev/agents/agent-creator.md Added ```markdown before line 145
plugins/plugin-dev/agents/skill-reviewer.md Added ```markdown before line 109

Testing

  • markdownlint passes on both files
  • Verified code blocks now properly open and close
  • plugin-validator.md unaffected (already correct)

🤖 Generated with Claude Code

Add opening ```markdown markers to the Output Format template sections
in agent-creator.md and skill-reviewer.md. These sections had closing
``` markers but were missing their opening markers, causing the output
templates to render as markdown instead of displaying as code examples.

Fixes #111

🤖 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 11, 2025

Claude finished @sjnims's task in 1m 47s —— View job


PR Review Complete ✓

Todo List

  • Read repository guidelines (CLAUDE.md)
  • Get PR diff to understand changes
  • Read changed agent files
  • Run markdownlint on changed files
  • Review against agent component criteria
  • Verify fix correctness and completeness
  • Check other agent files for similar issues
  • Post final review summary

Summary

Looks good - approve and merge

This is a well-executed minimal fix that resolves a legitimate markdown rendering issue.

What's Good

  1. Correctly identifies the problem: The Output Format sections in agent-creator.md (line 145) and skill-reviewer.md (line 109) were missing opening ```markdown markers, causing the template content to render as actual markdown instead of displaying as code examples.

  2. Minimal, surgical change: Adds exactly 2 lines (one per file) - the missing opening code block markers. This is the simplest possible fix.

  3. Pattern-consistent: Matches the correct format already used in plugin-validator.md:215, which has both opening and closing markers properly.

  4. Markdown quality: ✓ markdownlint passes with no errors on both changed files.

  5. Good PR description: Clear problem statement, solution explanation, and testing notes.

Agent Component Review

Agent Files Changed: 2 of 3 total agent files

  • plugins/plugin-dev/agents/agent-creator.md - ✓ Properly formatted now
  • plugins/plugin-dev/agents/skill-reviewer.md - ✓ Properly formatted now
  • plugins/plugin-dev/agents/plugin-validator.md - ✓ Already correct (reference pattern)

Both changed agents maintain:

  • ✓ Valid YAML frontmatter with required fields (name, description, model, color, tools)
  • ✓ Proper <example> blocks in descriptions
  • ✓ Appropriate tool restrictions
  • ✓ Consistent formatting with the reference pattern

Markdown Linting

markdownlint --config .markdownlint.json \
  plugins/plugin-dev/agents/agent-creator.md \
  plugins/plugin-dev/agents/skill-reviewer.md

Result: ✓ No errors or warnings

Verification

The changes are correct:

  • Before: Output Format sections had closing ``` without opening markers
  • After: Properly wrapped with ```markdown opening and ``` closing markers
  • Effect: Template content now displays as code examples (as intended) rather than being rendered as markdown

Checklist Verification

  • ✓ Fixes issue [Bug]: Missing code block markers in agent Output Format sections #111 as described
  • ✓ Minimal change (2 lines added)
  • ✓ Pattern matches plugin-validator.md (correct reference)
  • ✓ No markdown lint errors
  • ✓ All 3 agent files now have consistent formatting
  • ✓ No documentation updates needed (internal formatting fix only)
  • ✓ No functionality changes

Recommendation

Approve and merge. This is a straightforward fix with no risks or concerns.


@claude claude Bot added bug Something isn't working component:agent Agents layer effort:small < 1 hour labels Dec 11, 2025
@sjnims sjnims self-assigned this Dec 11, 2025
@sjnims sjnims merged commit c32b103 into main Dec 11, 2025
8 checks passed
@sjnims sjnims deleted the fix/111-missing-code-block-markers branch December 11, 2025 02:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working component:agent Agents layer effort:small < 1 hour

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Bug]: Missing code block markers in agent Output Format sections

1 participant