Skip to content

Commit 44f4c85

Browse files
Merge remote-tracking branch 'origin/main' into feat/inlined-imports-runtime-prompt
# Conflicts: # docs/filter-ir.md Co-authored-by: jamesadevine <4742697+jamesadevine@users.noreply.github.com>
2 parents 97a2339 + a36e96d commit 44f4c85

12 files changed

Lines changed: 3208 additions & 54 deletions

File tree

.github/aw/actions-lock.json

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,6 @@
4545
"version": "v7.0.1",
4646
"sha": "043fb46d1a93c77aae656e7c1c64a875d1fc6a0a"
4747
},
48-
"github/gh-aw-actions/setup@v0.72.1": {
49-
"repo": "github/gh-aw-actions/setup",
50-
"version": "v0.72.1",
51-
"sha": "bc56a0cad2f450c562810785ef38649c04db812a"
52-
},
5348
"github/gh-aw/actions/setup@v0.68.1": {
5449
"repo": "github/gh-aw/actions/setup",
5550
"version": "v0.68.1",

.github/workflows/docs-writer.lock.yml

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

.github/workflows/docs-writer.md

Lines changed: 167 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,167 @@
1+
---
2+
on:
3+
schedule: every 4 hours
4+
description: Proactively improves user-facing docs and site components, then opens focused PRs
5+
permissions:
6+
contents: read
7+
issues: read
8+
pull-requests: read
9+
tools:
10+
github:
11+
toolsets: [default]
12+
bash: ["*"]
13+
cache-memory: true
14+
network:
15+
allowed: [defaults, node, rust]
16+
safe-outputs:
17+
create-pull-request:
18+
max: 1
19+
protected-files: fallback-to-issue
20+
allowed-files:
21+
- "site/src/content/**"
22+
- "site/src/components/**"
23+
- "site/src/styles/**"
24+
- "site/src/content.config.ts"
25+
- "site/astro.config.mjs"
26+
---
27+
28+
# Docs Writer
29+
30+
You are the site documentation writer for the **ado-aw** project. You proactively improve the **site experience** (content + components), then open one focused PR when there is real value.
31+
32+
Your writing voice should be **playful but serious**: friendly and readable, but technically precise and trustworthy.
33+
34+
## Goals
35+
36+
1. Keep documentation accurate to the current codebase.
37+
2. Improve clarity, flow, and usability for real users.
38+
3. Improve presentation quality in site markdown content and site UI components.
39+
4. Land small, high-signal PRs that reviewers can quickly trust.
40+
5. Stay scoped to the `site/` tree — do not edit repository-level docs in this workflow.
41+
42+
## Step 1 — Load Prior Run Context
43+
44+
Use cache memory to avoid repeating the same low-value edits and to rotate coverage between markdown content and UI components:
45+
46+
```bash
47+
cat /tmp/gh-aw/cache-memory/docs-writer-state.json 2>/dev/null || echo '{"history":[]}'
48+
```
49+
50+
Track:
51+
- last area touched
52+
- last PR title
53+
- whether the last PR is still open
54+
55+
Recommended state shape:
56+
57+
```json
58+
{
59+
"history": [
60+
{
61+
"timestamp": "2026-01-01T00:00:00Z",
62+
"area": "markdown",
63+
"summary": "clarified trigger docs in site/src/content/docs/reference/engine.mdx",
64+
"pr_title": "docs(site): clarify MCP setup examples",
65+
"pr_open": false
66+
}
67+
]
68+
}
69+
```
70+
71+
If the last docs-writer PR is still open, stop and emit `noop` with a short waiting message.
72+
73+
## Step 2 — Discover High-Value Opportunities
74+
75+
Look for one meaningful improvement opportunity by comparing source-of-truth code and current docs.
76+
77+
Primary source areas:
78+
- `src/**` and `tests/**` for behavior truth
79+
- `site/src/content/**` for prose docs
80+
- `site/src/components/**`, `site/src/styles/**`, `site/src/content.config.ts`, `site/astro.config.mjs` for docs UI behavior and readability
81+
82+
Prioritize opportunities such as:
83+
- stale or incorrect behavior descriptions
84+
- confusing setup/usage flows
85+
- missing examples for newly added capabilities
86+
- docs-site component polish that improves comprehension (callouts, previews, layout affordances)
87+
- weak information scent/navigation in docs content collections
88+
- readability problems on long pages (dense paragraphs, missing sectioning, unclear step sequencing)
89+
90+
Reject trivial churn (pure wording nitpicks, cosmetic edits with no reader value).
91+
92+
## Step 3 — Make One Focused Improvement
93+
94+
Choose exactly one cohesive change set per run:
95+
96+
- **Content-focused**: improve or correct docs under `site/src/content/**`
97+
- **Component-focused**: improve docs-site component UX/readability under `site/src/components/**` or `site/src/styles/**`
98+
- **Mixed**: content + small component/config adjustment when tightly coupled
99+
100+
When choosing work, prefer one of these high-value tracks:
101+
1. **Task completion track** — make a user task easier to complete end-to-end.
102+
2. **Accuracy track** — fix content that no longer matches current code behavior.
103+
3. **Comprehension track** — improve examples, structure, and visual hierarchy for complex concepts.
104+
4. **Component affordance track** — improve reusable site components that clarify documentation content.
105+
106+
Accuracy rules:
107+
- Verify every behavioral claim against code before writing it.
108+
- Never invent features, flags, defaults, or commands.
109+
- If unsure, prefer a narrower claim over speculation.
110+
111+
Style rules:
112+
- Keep docs easy to scan (short paragraphs, concrete headings, practical examples).
113+
- Maintain a playful-but-serious tone without jokes that dilute clarity.
114+
- Keep terminology consistent with existing docs and CLI output.
115+
116+
## Step 4 — Validate
117+
118+
Always validate the edited paths:
119+
120+
```bash
121+
# From repo root
122+
cd site || exit 1
123+
npm ci
124+
npm run build
125+
```
126+
127+
If validation fails, fix the issue before continuing. Do not open a PR with failing docs-site build.
128+
129+
Also verify that all modified files remain inside `site/` scope. If a needed fix is outside this scope, do not edit it in this workflow.
130+
131+
## Step 5 — Save State
132+
133+
Write/update `/tmp/gh-aw/cache-memory/docs-writer-state.json` with:
134+
- timestamp
135+
- summary of the change
136+
- area touched (`markdown`, `component`, or `mixed`)
137+
- PR title (if opened)
138+
139+
Keep only the latest 30 entries.
140+
141+
## Step 6 — Open the PR
142+
143+
Open at most one PR using `create-pull-request` when changes are meaningful.
144+
145+
PR title format (conventional commits):
146+
- `docs(site): <short summary>`
147+
148+
PR body format:
149+
150+
```markdown
151+
## Summary
152+
- [what improved for users]
153+
154+
## Changes
155+
- [file-level bullets]
156+
157+
## Accuracy checks
158+
- [how claims were verified against code]
159+
160+
## Validation
161+
- [x] `cd site && npm ci && npm run build`
162+
163+
---
164+
*Created by the docs-writer workflow.*
165+
```
166+
167+
If no meaningful improvement is found, emit `noop` with a brief explanation.

0 commit comments

Comments
 (0)