Skip to content

docs: update README for Nextflow plugin registry compliance - #55

Merged
adamrtalbot merged 1 commit into
mainfrom
readme-registry-compliance
Jun 17, 2026
Merged

docs: update README for Nextflow plugin registry compliance#55
adamrtalbot merged 1 commit into
mainfrom
readme-registry-compliance

Conversation

@adamrtalbot

Copy link
Copy Markdown
Collaborator

Summary

  • Rename "Quick Start" → "Get Started" to match the registry's required section names
  • Use absolute GitHub URL for the notification screenshot so it renders on the registry
  • Add "Examples" section with bot configuration snippets (bot-only, no webhooks)

The Nextflow plugin registry requires README.md to include Summary, Get Started, Examples, and License sections. The releasePlugin Gradle task already sends the README as the documentation field — these changes ensure it passes registry validation and renders correctly.

- Rename 'Quick Start' to 'Get Started' to match registry required sections
- Use absolute GitHub URL for images so they render on the registry
- Add 'Examples' section with bot configuration snippets

Generated by Claude Code
@claude

claude Bot commented Feb 26, 2026

Copy link
Copy Markdown

Code Review

Documentation: Changes are accurate and well-targeted. Renaming "Quick Start" → "Get Started" and switching to an absolute image URL are the right fixes for registry compliance.

Examples: The two new bot snippets are clear and practical. Minor gap: no webhook example is included, even though webhooks are mentioned as a configuration option in the existing README. Consider adding a brief webhook snippet or noting it's covered via the gallery link.

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

UX: The new examples section flows naturally and the gallery link at the end is a good call-to-action.

Overall: Changes are minimal and purposeful. Approved with the suggestion to consider a webhook snippet in Examples to match the existing UX copy that mentions webhooks.

@adamrtalbot
adamrtalbot merged commit 909fd63 into main Jun 17, 2026
9 checks passed
@adamrtalbot
adamrtalbot deleted the readme-registry-compliance branch June 17, 2026 09:45
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