Skip to content

fix: correct admonition formatting and add missing bot permissions in docs#52

Merged
adamrtalbot merged 2 commits intomainfrom
fix/docs-admonition-formatting
Feb 19, 2026
Merged

fix: correct admonition formatting and add missing bot permissions in docs#52
adamrtalbot merged 2 commits intomainfrom
fix/docs-admonition-formatting

Conversation

@adamrtalbot
Copy link
Copy Markdown
Collaborator

Summary

  • Fix MkDocs admonition formatting across 4 doc files — content was missing the required 4-space indent, causing it to render outside the admonition box
  • Convert GitHub > [!NOTE] syntax to MkDocs !!! note in api.md
  • Fix code blocks in gallery.md (single backticks → triple backticks)
  • Add missing bot permissions (reactions:write, files:write) to the setup guide
  • Add <!-- prettier-ignore --> comments to protect admonition indentation from Prettier reformatting

Files changed

File Change
docs/usage/guide.md Fix 4 admonitions missing indentation
docs/index.md Fix 1 admonition missing indentation
docs/examples/gallery.md Fix admonition indent + code block backticks
docs/reference/api.md Convert GitHub note syntax to MkDocs admonition
docs/getting-started/setup.md Add reactions:write and files:write scopes

Generated by Claude Code
… docs

- Fix MkDocs admonition indentation in guide.md, index.md, gallery.md
- Convert GitHub > [!NOTE] syntax to MkDocs !!! note in api.md
- Fix single backtick code blocks to triple backticks in gallery.md
- Add reactions:write and files:write scopes to setup.md bot permissions

Generated by Claude Code
@claude
Copy link
Copy Markdown

claude bot commented Feb 19, 2026

PR Review

Summary: Doc formatting fixes + version bump to 0.5.0 + missing bot permissions.

Documentation ✅

  • Admonition indentation fixes are correct (4-space indent required by MkDocs).
  • <!-- prettier-ignore --> guards are a good safeguard to prevent regressions.
  • GitHub > [!NOTE] → MkDocs !!! note conversion in api.md is correct.
  • Code block fix in gallery.md (single backtick → triple backtick) is accurate.

Missing Bot Permissions ✅

  • reactions:write and files:write added to setup guide with links to relevant sections — clear and actionable.

Examples ✅

  • All example configs bumped to 0.5.0 consistently.

CHANGELOG ⚠️

  • build.gradle was 0.4.1 before this PR, but the CHANGELOG jumps from 0.4.0 to 0.5.00.4.1 has no changelog entry and no version history line. If 0.4.1 was ever published to the Nextflow plugin registry, users on that version won't find it in the changelog.

Tests

No new tests needed — this is a documentation-only change.

Minor

No issues.

@adamrtalbot adamrtalbot merged commit 1977a03 into main Feb 19, 2026
5 checks passed
@adamrtalbot adamrtalbot deleted the fix/docs-admonition-formatting branch February 19, 2026 11:42
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