Skip to content

Conversation

@github-actions
Copy link
Contributor

@github-actions github-actions bot commented Dec 7, 2025

Documentation Updates - December 6-7, 2025

This PR updates the CLI documentation based on user-facing features merged in the last 24 hours.

Features Documented

  1. gh aw init creates logs gitignore (from Add .github/aw/logs/.gitignore creation to init command #5712)

    • Updated init command documentation to mention that .github/aw/logs/.gitignore is now automatically created
    • This prevents downloaded workflow logs from being accidentally committed to the repository
  2. Fuzzy workflow name matching (from Add fuzzy matching suggestions for workflow name resolution #5710)

    • Added new "Smart Features" section documenting the fuzzy matching capability
    • Includes example output showing typo suggestions
    • Lists all commands that support fuzzy matching
    • Explains the Levenshtein distance algorithm used (max 3 suggestions within edit distance of 3)
    • Updated troubleshooting table to reference typo suggestions
  3. Auto-detection of safe-inputs in MCP inspect (from Auto-detect and inspect safe-inputs in MCP inspect with Go SDK #5709)

    • Updated gh aw mcp inspect documentation to clarify that safe-inputs are automatically detected
    • Removed reference to --safe-inputs flag (no longer needed)
    • Documented that imported safe-inputs from shared workflows are also detected

Changes Made

  • Updated docs/src/content/docs/setup/cli.md:
    • Enhanced init command description (line 79)
    • Added "Smart Features" section with fuzzy matching documentation (lines 418-444)
    • Updated troubleshooting table entry for "Workflow not found" (line 453)
    • Enhanced mcp inspect command description (lines 307-311)

Merged PRs Referenced

Notes

Other PRs merged in this period were either internal refactoring, bug fixes, test improvements, or installation script improvements that don't require user-facing documentation updates.

AI generated by Daily Documentation Updater

Document three user-facing features from December 6-7:

1. gh aw init now creates .github/aw/logs/.gitignore (#5712)
   - Prevents workflow logs from being committed

2. Fuzzy workflow name matching (#5710)
   - Added Smart Features section with examples
   - Documents typo suggestions across all commands
   - Explains Levenshtein distance matching algorithm

3. Auto-detection of safe-inputs in mcp inspect (#5709)
   - Clarified that safe-inputs are automatically detected
   - Removed reference to deprecated --safe-inputs flag
   - Documents imported safe-inputs support

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

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@github-actions github-actions bot added automation documentation Improvements or additions to documentation labels Dec 7, 2025
@mnkiefer mnkiefer requested a review from Copilot December 7, 2025 06:10
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the CLI documentation to reflect three user-facing features merged on December 6-7, 2025: automatic gitignore creation during init, fuzzy workflow name matching with typo suggestions, and automatic safe-inputs detection in MCP inspect.

  • Enhanced gh aw init documentation to mention automatic .gitignore creation for workflow logs
  • Added new "Smart Features" section documenting fuzzy matching capabilities with examples
  • Updated MCP inspect documentation to clarify automatic safe-inputs detection

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@pelikhan pelikhan merged commit f89757f into main Dec 7, 2025
11 checks passed
@pelikhan pelikhan deleted the docs-updates-2025-12-07-76e9c3ac7226602b branch December 7, 2025 07:20
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