-
Notifications
You must be signed in to change notification settings - Fork 311
Add builtin qmd documentation search tool (experimental)
#22183
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
e1cf3a4
16cd7f5
abf31d6
e09c697
8e48ff6
ef071a0
1207c52
0b53db3
13c5bfc
bae91d1
a7c99a5
a514cd6
0214243
7df829d
658c7f6
ee504c2
b999aea
bc6e3a6
ab98791
190c8fe
a733a53
f556ca8
d8aba88
38a173d
4dedc39
cda60c7
e960630
3ca35f9
9a53579
d64d138
78c2733
7ccf408
3549405
ca65494
94f59da
628bf91
4d91ff0
7aba33f
285c3d7
307bbec
1606b63
c90147f
3af7267
8a9cfee
16290ab
3c97bdc
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Large diffs are not rendered by default.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,7 @@ | ||
| --- | ||
| on: | ||
| workflow_dispatch: | ||
| label_command: dev | ||
| schedule: | ||
| - cron: '0 9 * * *' # Daily at 9 AM UTC | ||
| name: Dev | ||
|
|
@@ -14,6 +15,20 @@ permissions: | |
| issues: read | ||
| pull-requests: read | ||
|
|
||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The |
||
| tools: | ||
| qmd: | ||
| checkouts: | ||
| - name: docs | ||
| paths: | ||
| - docs/src/**/*.md | ||
| - docs/src/**/*.mdx | ||
| context: "gh-aw project documentation" | ||
| searches: | ||
| - name: issues | ||
| type: issues | ||
| max: 500 | ||
| github-token: ${{ secrets.GITHUB_TOKEN }} | ||
|
|
||
| safe-outputs: | ||
| create-issue: | ||
| expires: 7d | ||
|
|
@@ -24,14 +39,21 @@ features: | |
|
|
||
| # Daily Status Report | ||
|
|
||
| Generate a daily status report for the gh-aw project. | ||
| Generate a daily status report for the gh-aw project, focusing on documentation quality. | ||
|
|
||
| **Requirements:** | ||
| 1. Analyze the current state of the repository | ||
| 2. Check for recent commits, pull requests, and issues | ||
| 3. Identify any potential issues or areas needing attention | ||
| 4. Create a comprehensive daily status report | ||
| 5. Post the report as an issue with the date in the title | ||
|
|
||
| 1. **Find documentation problems reported in issues**: Use the `qmd` search tool to query the indexed issues collection for issues that mention documentation bugs, unclear instructions, missing documentation, or incorrect documentation. Look for patterns like "docs", "documentation", "unclear", "wrong", "missing", "broken", "outdated". | ||
|
|
||
| 2. **Cross-reference with current documentation**: For each documentation problem found in issues, use the `qmd` search tool to query the indexed docs collection to find the relevant documentation section that the issue is referencing or that could answer the question raised. | ||
|
|
||
| 3. **Compile a report** summarizing: | ||
| - Issues that report documentation problems (with issue numbers and titles) | ||
| - The corresponding documentation sections that may need updating | ||
| - Any issues where the documentation actually already contains the answer (and the issue could be closed with a pointer) | ||
| - Gaps where no documentation exists for a reported problem | ||
|
|
||
| 4. Post the report as an issue with the date in the title. | ||
|
|
||
| Keep the report informative but concise. | ||
|
|
||
|
|
||
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The
label_command: devtrigger looks good — this enables the workflow to react todevlabels on issues, PRs, and discussions. Consider documenting the expected behavior when this label is applied to ensure contributors understand the automation.