Conversation
Resolved critical, important, and minor documentation issues across 15 CLI reference files based on comprehensive audit. ## Critical fixes - actions.md: Added missing --pipeline and -w options - credentials.md: Added Options tables for add/update commands - participants.md: Fixed type mismatch (COLLABORATOR vs MEMBER) - pipelines.md: Added missing repository URL parameter - studios.md: Fixed wrong command references and moved checkpoints example - teams.md: Added missing -t and -o options to members commands ## Important fixes - actions.md: Added supported event sources (github, tower) - data-links.md: Replaced placeholders with concrete dummy values - datasets.md: Completed tw datasets view versions with Options and example - launch.md: Clarified pipeline parameter (name vs Git URL) - studios.md: Removed duplicate tw studios templates section - workspaces.md: Removed duplicate sections and fixed ordering ## Minor fixes - actions.md: Sanitized example IDs to consistent format - collaborators.md: Fixed inconsistent ID sanitization - credentials.md: Replaced placeholders with realistic dummy examples - datasets.md: Added -w flag to example and updated output - labels.md: Added examples showing resource labels vs regular labels - pipelines.md: Added -w flag to example and updated output ## Global updates - Updated all workspace flag descriptions to mention personal workspace fallback - studios.md: Special handling for workspace flag (not available in personal workspaces) - Standardized workspace descriptions across all 13 CLI reference files Co-Authored-By: Claude Sonnet 4.5 (1M context) <noreply@anthropic.com>
✅ Deploy Preview for seqera-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
@claude review |
|
Claude finished @llewellyn-sl's task —— View job PR Review: Fix CLI reference documentation issuesReview Progress
Critical Fixes Analysis ✅Reviewed 6 files with critical issues - all fixes are accurate and well-implemented: actions.md:130-131 - ✅ Added missing Important Fixes Analysis ✅Reviewed 6 files with important improvements - all changes are well-executed: actions.md:120-123 - ✅ Added comprehensive note listing supported event sources (github, tower) Minor Fixes & Global Updates Analysis ✅Excellent consistency improvements across all files: Global Standardization - ✅ Updated all workspace flag descriptions to include personal workspace fallback behavior with consistent wording: "defaults to Overall AssessmentThis PR successfully addresses comprehensive CLI documentation audit findings with excellent execution quality: ✅ Strengths
✅ Technical Quality
✅ RecommendationAPPROVE - This PR significantly improves CLI documentation quality and user experience. The fixes are comprehensive, accurate, and well-implemented across all priority levels. |
Summary
Comprehensive fixes for CLI reference documentation based on audit findings. Addresses all critical, important, and minor issues across 15 CLI reference files.
Changes
Critical Fixes (6 files)
--pipelineand-woptions to documentationaddandupdatecommands<repository-url>parameter documentationstart-as-new→add-as-new) and moved checkpoints example to correct section-tand-ooptions tomembers add/deletesubcommandsImportant Fixes (6 files)
tw datasets view versionssubcommand with Options table and exampletw studios templatessection, merged optionsMinor Fixes (7 files)
xxxsuffixes)-wworkspace flag to example, updated output to reflect workspace-wworkspace flag to example, updated output to reflect workspaceGlobal Updates (13 files)
TOWER_WORKSPACE_IDenvironment variable, or personal workspace if not set"studios.mdnotes that studios are not available in personal workspacesTesting
Related
Fixes issues identified in CLI documentation audit.
🤖 Generated with Claude Code