Skip to content

docs(conventional-release): tag fenced examples as text (MD040)#55

Merged
devantler merged 1 commit into
mainfrom
claude/docs-conventional-release-fence-langs
Jun 28, 2026
Merged

docs(conventional-release): tag fenced examples as text (MD040)#55
devantler merged 1 commit into
mainfrom
claude/docs-conventional-release-fence-langs

Conversation

@devantler

@devantler devantler commented Jun 28, 2026

Copy link
Copy Markdown
Contributor

🤖 Generated by the Daily AI Assistant

What

Add a text language identifier to the two bare fenced code blocks in conventional-release/SKILL.md (the Anatomy of the title example and the BREAKING CHANGE footer example).

Why

Both bare fences trip markdownlint MD040 (fenced-code-language). This is the root-cause of a CodeRabbit review thread on the consumer side — agent-plugins#36 bundles this skill verbatim via the update-agent-skills sync, so the bare fences surface there too. Fixing the source means the bundled copy picks it up on the next sync rather than diverging via a hand-edit of a synced artifact.

The other three in-house skills bundled by #36 (agent-instructions, ways-of-working, gitops-tenant-onboarding) were checked and have no bare fences.

Validation

  • Both fence blocks now carry ```text`; rendered output is identical (behaviour-preserving docs-only change).
  • Verified no remaining bare fences in the file.

Opened as a draft for promotion.

Summary by CodeRabbit

  • Documentation
    • Updated example formatting in the release guidance so code blocks now use a clear text label for better readability and consistency.

@coderabbitai

coderabbitai Bot commented Jun 28, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: f14ec6fa-3d9d-4e98-b60e-a00ccab2bb43

📥 Commits

Reviewing files that changed from the base of the PR and between cfd7665 and 66d323f.

📒 Files selected for processing (1)
  • conventional-release/SKILL.md

📝 Walkthrough

Walkthrough

Two unlabeled Markdown code fences in conventional-release/SKILL.md are updated to specify the text language identifier.

Changes

Docs: Code fence language labels

Layer / File(s) Summary
Add text language to code fences
conventional-release/SKILL.md
The "Anatomy of the title" and "Breaking changes → major" example blocks now use ```text instead of an unlabeled fence.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A rabbit hopped through docs one day,
Found fences bare—no label, no say!
Stamped text with a paw, neat and bright,
Now every code block shines just right.
🐇✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the docs-only change to label fenced examples as text and mentions the MD040 lint fix.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/docs-conventional-release-fence-langs

Comment @coderabbitai help to get the list of available commands.

@devantler devantler marked this pull request as ready for review June 28, 2026 14:30
@devantler devantler merged commit 69b72ea into main Jun 28, 2026
15 checks passed
@devantler devantler deleted the claude/docs-conventional-release-fence-langs branch June 28, 2026 15:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant