Skip to content

Commit 8b089d1

Browse files
authored
DDUw: add open-issue cross-referencing, stale schema drift detection, and example validation (#18555)
1 parent 25d5de0 commit 8b089d1

2 files changed

Lines changed: 23 additions & 2 deletions

File tree

‎.github/workflows/daily-doc-updater.lock.yml‎

Lines changed: 4 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎.github/workflows/daily-doc-updater.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,8 @@ tools:
4141
- "find docs -name '*.md' -exec cat {} +"
4242
- "grep -r '*' docs"
4343
- "git"
44+
- "find pkg/parser/schemas -name '*.json'"
45+
- "cat pkg/parser/schemas/*.json"
4446

4547
timeout-minutes: 45
4648

@@ -68,6 +70,20 @@ Use the GitHub tools to:
6870
- Review commits from the last 24 hours using `list_commits`
6971
- Get detailed commit information using `get_commit` for significant changes
7072

73+
### 1b. Check Open Documentation Issues
74+
75+
Search for open issues labeled `documentation` that may represent unaddressed gaps:
76+
77+
```
78+
repo:${{ github.repository }} is:issue is:open label:documentation
79+
```
80+
81+
For each open issue:
82+
1. Read the issue body to understand the described gap.
83+
2. Check the referenced documentation file to verify the gap still exists.
84+
3. If confirmed, include a fix in this run's PR and reference the issue with `Closes #NNN`.
85+
4. If the gap is already fixed, note it (do not reopen or comment on the issue).
86+
7187
### 2. Analyze Changes
7288

7389
For each merged PR and commit, analyze:
@@ -76,6 +92,7 @@ For each merged PR and commit, analyze:
7692
- **Features Removed**: Deprecated or removed functionality
7793
- **Features Modified**: Changed behavior, updated APIs, or modified interfaces
7894
- **Breaking Changes**: Any changes that affect existing users
95+
- **Removed Features in Docs**: Search docs for references to properties, flags, or options that no longer exist in the current schema. Check `pkg/parser/schemas/` or run `gh aw compile` on representative workflows to confirm current valid properties.
7996

8097
Create a summary of changes that should be documented.
8198

@@ -202,6 +219,8 @@ This PR updates the documentation based on features merged in the last 24 hours.
202219
- **Use Proper Format**: Use the correct Diátaxis category and Astro Starlight syntax
203220
- **Link References**: Include links to relevant PRs and issues where appropriate
204221
- **Test Understanding**: If unsure about a feature, review the code changes in detail
222+
- **Issue-Driven**: Proactively check open `documentation` issues — do not wait for them to be reported manually.
223+
- **Validate Examples**: YAML frontmatter examples in docs must be structurally valid. When in doubt, test with `gh aw compile`.
205224

206225
## Important Notes
207226

0 commit comments

Comments
 (0)