Skip to content

Commit 64c515f

Browse files
committed
Deploy daily-docs-review workflow
1 parent 3a8d58f commit 64c515f

File tree

1 file changed

+65
-0
lines changed

1 file changed

+65
-0
lines changed
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
name: Daily Documentation Review
3+
description: |
4+
Daily review of repository documentation validity against github.com, githubnext.com, and gh-aw resources.
5+
on:
6+
schedule:
7+
- cron: 'daily'
8+
workflow_dispatch:
9+
10+
permissions:
11+
contents: read
12+
issues: read
13+
14+
network:
15+
firewall: true
16+
allowed:
17+
- "*.github.com"
18+
- "github.com"
19+
- "*.githubnext.com"
20+
- "githubnext.com"
21+
- "api.github.com"
22+
- "github.blog"
23+
24+
engine:
25+
id: copilot
26+
27+
timeout-minutes: 60
28+
29+
tools:
30+
bash:
31+
- ls
32+
- find
33+
- grep
34+
- cat
35+
edit: {}
36+
web-fetch: {}
37+
memory: cache-memory
38+
39+
safe-outputs:
40+
create-pull-request:
41+
title-prefix: "docs: "
42+
draft: false
43+
---
44+
45+
# Daily Documentation Review
46+
47+
## Context
48+
This workflow performs a daily review of the repository's documentation to ensure accuracy and freshness. It validates content against authoritative external sources.
49+
50+
## Instructions
51+
1. **Initialize**: Read from your memory to see which files and links were checked recently.
52+
2. **Scan Documentation**: Read through the `docs/` directory and `README.md`.
53+
3. **Verify Claims**: For each key technical claim or feature description:
54+
- **Skip** if verified successfully within the last 3 days (check memory).
55+
- otherwise use `web-fetch` to check `github.com` and `githubnext.com` pages for the latest information.
56+
- Check the `github/gh-aw` project for updates if relevant.
57+
4. **Report Findings**:
58+
- If inaccuracies are found, **edit the files** to correct them.
59+
- Create a **Pull Request** with the fixes. Use the `create-pull-request` tool.
60+
- If all documentation is up-to-date, output a summary of checks performed.
61+
5. **Update Memory**: Record the current date for the files/claims verified in this run.
62+
63+
## External Verification
64+
Use `web-fetch` to confirm details. Prioritize official GitHub sources.
65+
If you need to check a specific URL, use `web-fetch`.

0 commit comments

Comments
 (0)