Skip to content

Conversation

@github-actions
Copy link
Contributor

Documentation Updates - November 15, 2025

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

Features Documented

  1. Cross-repository --repo flag (from 🚀 Add --repo option to workflow management commands #4007)

    • Added --repo option to enable, disable, and logs commands
    • Enables workflow management operations across different repositories
    • Updated CLI reference with examples and option descriptions
  2. Workflow description extraction (from 👨‍💻 Add workflow description extraction feature #4008)

    • Documents that add and trial commands now display workflow descriptions
    • Descriptions are extracted from frontmatter description field
    • Provides better context about workflow purpose when adding or testing
  3. Import cache for offline compilation (from Add import cache for offline workflow compilation with SHA-based storage #3981)

    • Remote imports are automatically cached in .github/aw/imports/
    • Cache stores imports by commit SHA for efficient reuse
    • Enables offline compilation once imports have been downloaded
    • Updated CLI, imports reference, and packaging guides
  4. "Did You Mean" schema validation suggestions (from [WIP] Implement 'Did You Mean' suggestions for schema validation #3999)

    • Compiler suggests correct field names for typos using fuzzy matching
    • Based on Levenshtein distance algorithm
    • Added tip callout and new error documentation section
    • Includes examples of common typos detected

Changes Made

  • Updated docs/src/content/docs/setup/cli.md:

    • Added --repo flag to enable, disable, and logs commands
    • Added -e, --engine flag to logs command
    • Documented workflow description display for add and trial commands
    • Added note about import caching in compile command
  • Updated docs/src/content/docs/reference/imports.md:

    • Added "Import Cache" section explaining automatic caching
    • Documented cache location and organization
    • Explained offline compilation capability
  • Updated docs/src/content/docs/guides/packaging-imports.md:

    • Added note about import caching in the Imports section
  • Updated docs/src/content/docs/troubleshooting/errors.md:

    • Added tip callout about typo detection in Schema Validation Errors section
    • Added new "Unknown Property" error section with "Did You Mean" examples
    • Listed common typos that are automatically detected

Merged PRs Referenced

Notes

All documentation follows the Diátaxis framework and maintains consistency with existing documentation style. Changes are technical and concise, avoiding marketing language.


🤖 Generated with Claude Code

Co-Authored-By: Claude (noreply@anthropic.com)

AI generated by Daily Documentation Updater

This commit updates the documentation based on features merged in the last 24 hours.

## Features Documented

### 1. Cross-repository --repo flag (PR #4007)
- Added --repo option to enable, disable, and logs commands
- Enables workflow management operations across different repositories
- Updated CLI reference with examples and option descriptions

### 2. Workflow description extraction (PR #4008)
- Documents that add and trial commands now display workflow descriptions
- Descriptions are extracted from frontmatter description field
- Provides better context about workflow purpose when adding or testing

### 3. Import cache for offline compilation (PR #3981)
- Remote imports are automatically cached in .github/aw/imports/
- Cache stores imports by commit SHA for efficient reuse
- Enables offline compilation once imports have been downloaded
- Updated CLI, imports reference, and packaging guides

### 4. "Did You Mean" schema validation suggestions (PR #3999)
- Compiler suggests correct field names for typos using fuzzy matching
- Based on Levenshtein distance algorithm
- Added tip callout and new error documentation section
- Includes examples of common typos detected

## Files Modified

- docs/src/content/docs/setup/cli.md
- docs/src/content/docs/reference/imports.md
- docs/src/content/docs/guides/packaging-imports.md
- docs/src/content/docs/troubleshooting/errors.md

## Related PRs

- #4007 - Add --repo options to more commands
- #4008 - Add workflow description extraction feature
- #3981 - Add import cache for offline workflow compilation
- #3999 - Implement 'Did You Mean' suggestions for schema validation

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

Co-Authored-By: Claude <noreply@anthropic.com>
@github-actions github-actions bot added automation documentation Improvements or additions to documentation labels Nov 15, 2025
@pelikhan pelikhan merged commit 2b40196 into main Nov 15, 2025
4 checks passed
@pelikhan pelikhan deleted the docs/update-nov-15-features-7833d313d295dc5c branch November 15, 2025 06:25
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