docs: update README for Nextflow plugin registry compliance#55
docs: update README for Nextflow plugin registry compliance#55adamrtalbot wants to merge 1 commit intomainfrom
Conversation
- 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
Code ReviewDocumentation: 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. |
Summary
The Nextflow plugin registry requires README.md to include Summary, Get Started, Examples, and License sections. The
releasePluginGradle task already sends the README as the documentation field — these changes ensure it passes registry validation and renders correctly.