|
| 1 | +--- |
| 2 | +name: doc-update-past-month |
| 3 | +description: Generate a summary of meaningful public documentation updates from the previous calendar month, scoped to a product area. |
| 4 | +--- |
| 5 | + |
| 6 | +Use this skill when asked to summarize recent documentation updates, changelog entries, or "what's new" in the public docs for a specific product area. |
| 7 | + |
| 8 | +## How it works |
| 9 | + |
| 10 | +A helper script at `.agents/skills/doc-update-past-month/bin/doc-update-past-month.js` produces a formatted summary of what changed in the previous calendar month. |
| 11 | + |
| 12 | +**Changelog entries** are discovered by scanning all `.mdx` files under `src/content/changelog/` on `origin/production` and filtering by the `date:` field in frontmatter. This ensures entries are included based on their published date, not when the PR was merged. |
| 13 | + |
| 14 | +**Documentation updates** are discovered by querying git commit dates in the target range and filtering out trivial changes. |
| 15 | + |
| 16 | +## Supported areas |
| 17 | + |
| 18 | +| Argument | Area | |
| 19 | +|----------|------| |
| 20 | +| `app_perf` | Application Performance | |
| 21 | +| `app_sec` | Application Security | |
| 22 | +| `cf1` | Cloudflare One | |
| 23 | +| `platform` | Platform | |
| 24 | +| `dev_plat` | Developer Platform | |
| 25 | + |
| 26 | +The following products are **always included** regardless of area: |
| 27 | +- Support |
| 28 | +- Fundamentals |
| 29 | +- Terraform |
| 30 | + |
| 31 | +## Usage |
| 32 | + |
| 33 | +Run the helper script with the desired area: |
| 34 | + |
| 35 | +```bash |
| 36 | +node .agents/skills/doc-update-past-month/bin/doc-update-past-month.js <area> |
| 37 | +``` |
| 38 | + |
| 39 | +## Output format |
| 40 | + |
| 41 | +The script prints: |
| 42 | + |
| 43 | +1. A heading with the previous month and year. |
| 44 | +2. **Changelog entries** in the form: |
| 45 | + ``` |
| 46 | + New changelog entry for <product>: <title from changelog frontmatter> |
| 47 | +
|
| 48 | + <first sentence from changelog body> |
| 49 | + - https://developers.cloudflare.com/changelog/post/<date-slug>/ |
| 50 | + ``` |
| 51 | + The title is read from the changelog file's frontmatter (`title:` field), and the summary is the first sentence of the body content (after skipping any leading markdown headings or import statements). |
| 52 | +3. **Documentation updates** in the form: |
| 53 | + ``` |
| 54 | + Update to the <product> documentation: <commit title> |
| 55 | + - https://developers.cloudflare.com/<product>/<path>/ |
| 56 | + ``` |
| 57 | + |
| 58 | +## Filtering heuristics |
| 59 | + |
| 60 | +The script automatically excludes doc update commits that appear trivial: |
| 61 | +- Typo fixes |
| 62 | +- Broken-link fixes |
| 63 | +- Bulk standardization or formatting changes |
| 64 | +- Commits whose message is only "Update index.mdx" or "Update {file}.mdx" |
| 65 | +- Chore commits (`[Chore]`, `chore:`) |
| 66 | +- Release-notes routine updates |
| 67 | +- Build-warning fixes |
| 68 | +- Trailing-space removals |
| 69 | +- Beta-badge removals |
| 70 | +- Style-guide bulk changes |
| 71 | + |
| 72 | +If a commit touches files across more than five different products, it is treated as a bulk change and excluded. |
| 73 | + |
| 74 | +Changelog entries are not filtered by heuristics — every entry whose frontmatter date falls within the target month is included. |
| 75 | + |
| 76 | +## Manual review |
| 77 | + |
| 78 | +After the script runs, review the output. If you notice any remaining trivial items in the docs section, you may remove them before sharing. |
0 commit comments