You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: Update documentation for features from November 15, 2025
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>
Copy file name to clipboardExpand all lines: docs/src/content/docs/guides/packaging-imports.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,6 +46,8 @@ imports:
46
46
47
47
During `gh aw add`, imports are expanded to track source repository (e.g., `shared/common-tools.md` becomes `githubnext/agentics/shared/common-tools.md@abc123def`).
48
48
49
+
Remote imports are automatically cached in `.github/aw/imports/` by commit SHA. This enables offline workflow compilation once imports have been downloaded. The cache is shared across different refs pointing to the same commit, reducing redundant downloads.
50
+
49
51
## Example: Modular Workflow with Imports
50
52
51
53
Create a shared MCP server configuration in `.github/workflows/shared/mcp/tavily.md`:
Copy file name to clipboardExpand all lines: docs/src/content/docs/reference/imports.md
+12Lines changed: 12 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -45,6 +45,18 @@ Import paths support local files (`shared/file.md`, `../file.md`), remote reposi
45
45
46
46
Paths are resolved relative to the importing file, with support for nested imports and circular import protection.
47
47
48
+
## Import Cache
49
+
50
+
Remote imports are automatically cached in `.github/aw/imports/` to enable offline compilation. The cache stores imports by commit SHA, allowing different refs (branches, tags) pointing to the same commit to share cached files.
51
+
52
+
When compiling workflows with remote imports:
53
+
- First compilation downloads the import and stores it in the cache
54
+
- Subsequent compilations use the cached file, eliminating network calls
55
+
- Cache is organized by owner/repo/sha/path for efficient lookups
56
+
- Local imports are never cached and are always read from the filesystem
57
+
58
+
The cache directory is git-tracked and automatically configured with `.gitattributes` to mark cached files as generated content with conflict-free merge behavior.
59
+
48
60
## Agent Files
49
61
50
62
Import custom agent files from `.github/agents/` to customize AI engine behavior. Agent files are markdown documents with specialized instructions that modify how the AI interprets and executes workflows.
Copy file name to clipboardExpand all lines: docs/src/content/docs/setup/cli.md
+17Lines changed: 17 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -98,6 +98,8 @@ gh aw add ci-doctor --dir shared --number 3 # Organize and create copies
98
98
gh aw add ci-doctor --pr # Create PR instead of direct commit
99
99
```
100
100
101
+
When adding a workflow, the command displays the workflow description (extracted from the frontmatter `description` field) to provide context about the workflow's purpose.
gh aw compile --purge # Remove orphaned .lock.yml files
133
135
```
134
136
137
+
Remote imports are automatically cached in `.github/aw/imports/` for offline compilation. First compilation downloads imports; subsequent compilations use cached files, eliminating network calls.
138
+
135
139
**Key Options:**
136
140
137
141
| Option | Description |
@@ -159,6 +163,8 @@ gh aw trial ./issue-workflow.md --trigger-context "#123" # With issue context
159
163
gh aw trial ./workflow.md --repo owner/repo # Run directly in repository
160
164
```
161
165
166
+
When trialing a workflow, the command displays the workflow description (extracted from the frontmatter `description` field) to provide context about what the workflow does.
167
+
162
168
**Key Options:**
163
169
164
170
| Option | Description |
@@ -219,17 +225,20 @@ gh aw logs # Download logs for all workflows
219
225
gh aw logs workflow-name # Download logs for specific workflow
220
226
gh aw logs -c 10 --start-date -1w # Filter by count and date
Copy file name to clipboardExpand all lines: docs/src/content/docs/troubleshooting/errors.md
+38Lines changed: 38 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,6 +11,10 @@ This reference documents common error messages encountered when working with Git
11
11
12
12
Schema validation errors occur when the workflow frontmatter does not conform to the expected JSON schema. These errors are detected during the compilation process.
13
13
14
+
:::tip[Typo Detection]
15
+
When you make a typo in frontmatter field names, the compiler automatically suggests correct field names using fuzzy matching. Look for "Did you mean" suggestions in error messages to quickly identify and fix common typos like `permisions` → `permissions` or `engnie` → `engine`.
16
+
:::
17
+
14
18
### Frontmatter Not Properly Closed
15
19
16
20
**Error Message:**
@@ -81,6 +85,40 @@ timeout-minutes: "10"
81
85
timeout-minutes: 10
82
86
```
83
87
88
+
### Unknown Property
89
+
90
+
**Error Message:**
91
+
```
92
+
Unknown property: permisions. Did you mean 'permissions'?
93
+
```
94
+
95
+
**Cause:** A field name in the frontmatter is not recognized by the schema validator, often due to a typo.
96
+
97
+
**Solution:** Use the suggested field name from the error message. The compiler uses fuzzy matching to suggest the most likely correct field names based on edit distance.
0 commit comments