Skip to content

docs(seqera-ai): document new skills and modes#1192

Merged
llewellyn-sl merged 8 commits intomasterfrom
codex/seqera-ai-cli-new-features-docs
Mar 12, 2026
Merged

docs(seqera-ai): document new skills and modes#1192
llewellyn-sl merged 8 commits intomasterfrom
codex/seqera-ai-cli-new-features-docs

Conversation

@llewellyn-sl
Copy link
Contributor

Summary

  • add dedicated Seqera AI docs for skills and modes
  • update overview, installation, quickstart, and use cases for skills, plan mode, and goal mode
  • refresh agent integration pages and sidebar links

Notes

  • documented these features as live based on the current portal CLI implementation and recent docs/feature branches
  • follow-up review comments incorporated for examples, mode-check guidance, shortcut wording, and skill precedence wording

@netlify
Copy link

netlify bot commented Mar 11, 2026

Deploy Preview for seqera-docs ready!

Name Link
🔨 Latest commit 950035d
🔍 Latest deploy log https://app.netlify.com/projects/seqera-docs/deploys/69b28135adb4a90008df9e0b
😎 Deploy Preview https://deploy-preview-1192--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 llewellyn-sl marked this pull request as ready for review March 11, 2026 18:23
@llewellyn-sl
Copy link
Contributor Author

@claude review

@claude
Copy link

claude bot commented Mar 11, 2026

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


Reviewing PR: docs(seqera-ai): document new skills and modes

I've conducted a comprehensive review of this PR that adds dedicated documentation for Seqera AI skills and modes features. Here's my analysis:

Tasks:

  • Read repository guidelines (CLAUDE.md)
  • Review new files: modes.md and skills.md
  • Review updated documentation files
  • Check sidebar configuration changes
  • Analyze content for consistency and quality
  • Provide comprehensive review feedback

Review Summary

This is an excellent documentation update that significantly improves the Seqera AI CLI documentation. The PR successfully adds comprehensive coverage for two major features (skills and modes) while maintaining consistency with existing documentation standards.

Strengths

Content Quality

  • Comprehensive feature coverage: New modes.md and skills.md files provide thorough documentation for build/plan/goal modes and the skills system
  • Clear structure: Logical organization with appropriate sections, examples, and cross-references
  • Practical examples: Good use of real-world examples throughout (especially in use-cases.md)
  • Consistent voice: Second-person perspective maintained throughout ("you can", "use this when")
  • Complete skill table: The built-in skills table in skills.md:35-53 provides comprehensive reference

Technical Accuracy

  • Accurate command syntax: All CLI commands and examples appear correct
  • Proper skill precedence documentation: Clear explanation of skill discovery order in skills.md:82-94
  • Correct mode descriptions: Accurate technical details about build/plan/goal mode behaviors
  • Updated sidebar integration: Proper placement of new pages in navigation hierarchy

Documentation Standards

  • Consistent frontmatter: All files use proper YAML frontmatter with required fields
  • Cross-linking: Good use of relative links between related pages
  • Note callouts: Appropriate use of :::note blocks for important information
  • Date consistency: All files use consistent "2026-03-11" date

Minor Issues Identified

Voice and Tone

  1. skills.md:80: "You can add skills by creating..." - Consider "Add skills by creating..." for more direct voice
  2. installation.md:57-58: "If you use Seqera AI as a skill..." - Long sentence that could be broken down for better readability
  3. modes.md:43: "If the assistant tries to use one of these tools, the request is rejected..." - Could be more direct: "When the assistant tries to use these tools, the request is rejected..."

Terminology and Consistency

  1. modes.md:79: "Seqera AI currently gives goal mode up to 3 model attempts" - Consider using consistent terminology (e.g., "attempt limit" used elsewhere)
  2. use-cases.md:316: "Skills exposed by your Seqera AI deployment also appear..." - Consider "Backend skills also appear..." for consistency with other references

Content Structure

  1. skills.md:55: Consider adding a note that the exact list may vary by deployment version, not just environment
  2. use-cases.md:294-317: The slash commands table duplicates some content from skills.md - consider consolidating or cross-referencing more clearly

Technical Review

File Organization

  • ✅ New files properly placed in platform-cloud/docs/seqera-ai/
  • ✅ Sidebar configuration correctly updated with new pages
  • ✅ Navigation hierarchy logical and intuitive

Content Integration

  • ✅ Existing files appropriately updated to reference new features
  • ✅ Cross-references between pages are comprehensive and accurate
  • ✅ Get-started flow properly incorporates new mode concepts

Code Examples

  • ✅ All bash commands use proper syntax and formatting
  • ✅ Keyboard shortcuts correctly documented (Shift+Tab)
  • ✅ Skill installation examples are practical and accurate

Overall Assessment

This PR represents a significant improvement to the Seqera AI documentation. The new skills and modes features are well-documented with:

  • Clear explanations of when and how to use each feature
  • Practical examples that help users understand the capabilities
  • Proper integration with existing documentation structure
  • Good attention to user experience and learning flow

The documentation successfully moves from basic concepts (installation, authentication) through core features (skills, modes) to advanced usage patterns. The quality is consistent with existing Seqera documentation standards.

Recommendation

✅ Approved - This PR is ready to merge. The minor voice/tone issues identified above are optional improvements that don't detract from the overall quality and completeness of the documentation.


@llewellyn-sl llewellyn-sl self-assigned this Mar 11, 2026
@justinegeffen justinegeffen added the 2. Reviews complete Reviews complete. Remove label when confirmed in prod. label Mar 11, 2026
Signed-off-by: Llewellyn vd Berg <113503285+llewellyn-sl@users.noreply.github.com>
@llewellyn-sl llewellyn-sl merged commit 3311e71 into master Mar 12, 2026
7 checks passed
@llewellyn-sl llewellyn-sl deleted the codex/seqera-ai-cli-new-features-docs branch March 12, 2026 19:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

2. Reviews complete Reviews complete. Remove label when confirmed in prod.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants