Skip to content

Comments

Fix CLI reference documentation issues#1149

Open
llewellyn-sl wants to merge 1 commit intomasterfrom
fix-cli-docs-compute-envs-runs
Open

Fix CLI reference documentation issues#1149
llewellyn-sl wants to merge 1 commit intomasterfrom
fix-cli-docs-compute-envs-runs

Conversation

@llewellyn-sl
Copy link
Contributor

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)

  • actions.md: Added missing --pipeline and -w options to documentation
  • credentials.md: Added complete Options tables for add and update commands
  • participants.md: Fixed type mismatch between description (COLLABORATOR) and example (MEMBER)
  • pipelines.md: Added missing <repository-url> parameter documentation
  • studios.md: Fixed incorrect command reference (start-as-newadd-as-new) and moved checkpoints example to correct section
  • teams.md: Added missing -t and -o options to members add/delete subcommands

Important Fixes (6 files)

  • actions.md: Added note listing supported event sources (github, tower)
  • data-links.md: Replaced all placeholder values with concrete dummy examples
  • datasets.md: Completed tw datasets view versions subcommand with Options table and example
  • launch.md: Clarified pipeline parameter usage (saved pipeline name vs Git URL)
  • studios.md: Removed duplicate tw studios templates section, merged options
  • workspaces.md: Removed duplicate command sections, fixed illogical ordering (delete before add)

Minor Fixes (7 files)

  • actions.md: Sanitized example IDs to consistent format
  • collaborators.md: Fixed inconsistent ID sanitization (removed xxx suffixes)
  • credentials.md: Replaced placeholders with realistic dummy examples (AWS keys, GitHub tokens, etc.)
  • datasets.md: Added -w workspace flag to example, updated output to reflect workspace
  • labels.md: Added examples showing difference between resource labels and regular labels
  • pipelines.md: Added -w workspace flag to example, updated output to reflect workspace

Global Updates (13 files)

  • Updated all workspace flag descriptions to include personal workspace fallback behavior
  • Standardized workspace descriptions: "defaults to TOWER_WORKSPACE_ID environment variable, or personal workspace if not set"
  • Exception: studios.md notes that studios are not available in personal workspaces

Testing

  • All pre-commit hooks passed
  • Documentation structure verified
  • Examples use consistent dummy values throughout

Related

Fixes issues identified in CLI documentation audit.

🤖 Generated with Claude Code

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>
@netlify
Copy link

netlify bot commented Feb 20, 2026

Deploy Preview for seqera-docs ready!

Name Link
🔨 Latest commit ffe5ca7
🔍 Latest deploy log https://app.netlify.com/projects/seqera-docs/deploys/6998228e049bbd00089cd4e9
😎 Deploy Preview https://deploy-preview-1149--seqera-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@llewellyn-sl
Copy link
Contributor Author

@claude review

@claude
Copy link

claude bot commented Feb 20, 2026

Claude finished @llewellyn-sl's task —— View job


PR Review: Fix CLI reference documentation issues

Review Progress

  • Analyze PR scope and changes
  • Review critical fixes (6 files)
  • Review important fixes (6 files)
  • Review minor fixes and global updates
  • Provide overall assessment and recommendations

Critical Fixes Analysis ✅

Reviewed 6 files with critical issues - all fixes are accurate and well-implemented:

actions.md:130-131 - ✅ Added missing --pipeline and -w options properly documented
credentials.md:28-32,102-112 - ✅ Added complete Options tables for add and update commands with proper provider-specific notes
participants.md:50 - ✅ Fixed type mismatch - corrected description from COLLABORATOR to MEMBER to match example
pipelines.md:68 - ✅ Added missing <repository-url> parameter documentation in options table
studios.md:169,178 - ✅ Fixed incorrect command reference (start-as-newadd-as-new) and moved example to correct section
teams.md:127,162,192 - ✅ Added missing -t and -o options to members add/delete subcommands with proper descriptions

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)
data-links.md - ✅ Replaced all placeholder values with realistic dummy examples throughout
datasets.md:200-238 - ✅ Completed tw datasets view versions subcommand with full Options table and example
launch.md:16-20 - ✅ Added clear clarification of pipeline parameter usage (saved pipeline name vs Git URL)
studios.md - ✅ Removed duplicate tw studios templates section and merged options appropriately
workspaces.md - ✅ Removed duplicate command sections and fixed logical ordering issues

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 TOWER_WORKSPACE_ID environment variable, or personal workspace if not set"
Example Improvements - ✅ Sanitized example IDs to consistent format and replaced placeholders with realistic dummy values
Documentation Accuracy - ✅ Fixed inconsistent ID sanitization and added -w workspace flags to examples with corresponding output updates

Overall Assessment

This PR successfully addresses comprehensive CLI documentation audit findings with excellent execution quality:

Strengths

  • Complete coverage: All 15 files systematically improved
  • Consistent standards: Global standardization of workspace descriptions and example formats
  • Accurate fixes: All critical issues properly resolved (missing options, incorrect references, type mismatches)
  • User-friendly improvements: Added clarifications, completed missing sections, removed duplicates
  • Quality examples: Realistic dummy data throughout for better understanding

Technical Quality

  • Proper documentation structure maintained
  • Consistent markdown formatting
  • Accurate option tables with Required/Default columns
  • Proper cross-references to related documentation

Recommendation

APPROVE - This PR significantly improves CLI documentation quality and user experience. The fixes are comprehensive, accurate, and well-implemented across all priority levels.


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.

2 participants