Skip to content

Conversation

@github-actions
Copy link
Contributor

Documentation Updates - October 26, 2025

This PR updates the CLI reference documentation based on features merged in the last 24 hours.

Features Documented

  1. Init command workflow creation guidance (from Update init command to guide users to create workflows via chat prompt #2567)

    • Documents new prompt: activate @.github/prompts/create-agentic-workflow.prompt.md
    • Adds "Repository Initialization" subsection with clear instructions
    • Reorganizes workflow creation section for better clarity
  2. Validate flag behavior change (from Fix: Disable container validation by default, require --validate flag #2550)

    • Documents that --validate flag now defaults to false (was true)
    • Explains flag enables both schema and container image validation
    • Clarifies when to use validation (verify correctness, slower compilation)

Changes Made

  • Updated docs/src/content/docs/tools/cli.md:
    • Added "Repository Initialization" subsection under "Workflow Creation and Management"
    • Documented post-init workflow creation guidance with activation prompt
    • Added "Validation" section explaining --validate flag behavior
    • Updated compile command example comment to reflect validation includes containers
    • Reorganized content for better flow and clarity

Merged PRs Referenced

Analysis Notes

Other merged PRs reviewed (no documentation needed):

All changes follow the Diátaxis framework with reference-style documentation for CLI commands. Content is concise, technically accurate, and uses neutral tone per documentation guidelines.

🤖 Generated with Claude Code

Co-Authored-By: Claude [email protected]

AI generated by Daily Documentation Updater

Update documentation to reflect recent CLI changes:

- Document init command's new workflow creation guidance
- Clarify --validate flag behavior (disabled by default)
- Reorganize workflow creation section for better clarity

Changes based on:
- PR #2567: Init command now guides users to activate create-agentic-workflow prompt
- PR #2550: --validate flag now defaults to false for faster compilation

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@github-actions github-actions bot added automation documentation Improvements or additions to documentation labels Oct 27, 2025
@pelikhan pelikhan merged commit a577a24 into main Oct 27, 2025
4 checks passed
@pelikhan pelikhan deleted the docs/update-cli-reference-oct26-fbfbd9a3adea418f branch October 27, 2025 11:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants