# Docs & Changelog Watcher to Change Records (`awesome_highboy/docs-changelog-watcher`) Actor

Track changes across docs, changelogs & API references you own or are authorized to monitor. Deterministic sha256 delta detection emits structured change records (added/removed/modified) per section, not noisy visual diffs. Schedule it; pay only for pages that changed.

- **URL**: https://apify.com/awesome\_highboy/docs-changelog-watcher.md
- **Developed by:** [Adam](https://apify.com/awesome_highboy) (community)
- **Categories:** Developer tools, AI, Automation
- **Stats:** 1 total users, 0 monthly users, 0.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

Pay per event

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event

## What's an Apify Actor?

Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md):

```bash
npm install apify-client
```

In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md):

```bash
pip install apify-client
```

In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md):

````bash
# MacOS / Linux
curl -fsSL https://apify.com/install-cli.sh | bash
# Windows
irm https://apify.com/install-cli.ps1 | iex
```bash

In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md).

If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).


# README

## Docs & Changelog Watcher to Change Records

Watch documentation and changelog pages and turn what *changed between runs* into clean, structured `change_record` rows. The diff is deterministic and content-hash based, so re-running on unchanged pages produces nothing and changed sections are pinpointed exactly.

### What it does

For each source page you give it, every run:

1. Fetches the page over HTTP (no API key) and reduces the HTML to text.
2. Segments the text into sections by heading, and token-chunks each section into `{ section_path, chunk_text }` units.
3. Loads the prior run's **snapshot** (a list of `{ section_path, content_hash }`) for that page from the Apify Key-Value Store.
4. Computes the delta against that snapshot:
   - **added** — a section path (or content) that was not in the prior snapshot.
   - **removed** — a prior section path that is absent this run.
   - **modified** — same section path, different content hash.
   - On the **first run** (no prior snapshot) every section is reported as `added`.
5. Emits one `change_record` per delta. Unchanged sections emit nothing.
6. Stores the new snapshot back to the Key-Value Store for the next run.
7. Writes one `run_summary` with the run totals.

Pages that fail to fetch are skipped (and not billed), so one bad URL never fails the whole run.

### Deterministic core

The change detection is a pure function, offline-testable with no network, no LLM, and no API keys:

````

diffChunks(prevHashes, currentChunks) -> \[ change\_record, ... ]

````

- `prevHashes` — the prior snapshot: either `[{ section_path, content_hash }]` or a bare `['sha256:...', ...]` array.
- `currentChunks` — `[{ section_path, chunk_text }]` from `segmentDoc`.
- Hashing uses `core.js` `contentHash`; chunking uses `core.js` `chunkText`.

Same input always yields the same hashes and the same diff (idempotent).

### Input

| Field | Type | Required | Description |
|---|---|---|---|
| `sources` | array | Yes | Docs/changelog page URLs to watch. Each item is a URL string or `{ url }`. |
| `segmentation` | object | No | `{ maxTokens, overlapTokens }` controlling section chunk size and overlap before hashing/diffing. |
| `ownership_attestation` | boolean | Yes | You must confirm you own / are authorized to monitor these pages and will honor each site's terms. The run is rejected before any work or billing if this is not `true`. |

### Output

Every record has a `record_type` field.

**`change_record`** — one per detected delta:

| Field | Type | Description |
|---|---|---|
| `record_type` | string | Always `"change_record"`. |
| `change_type` | string | `"added"`, `"removed"`, or `"modified"`. |
| `source_url` | string | The page the change was found on. |
| `section_path` | string | The section heading path the change belongs to. |
| `old_content_hash` | string\|null | Prior section content hash (`null` for `added`). |
| `new_content_hash` | string\|null | Current section content hash (`null` for `removed`). |
| `chunk_text` | string | Current section text (empty for `removed`). |

**`run_summary`** — exactly one per run:

| Field | Type | Description |
|---|---|---|
| `record_type` | string | Always `"run_summary"`. |
| `pages_checked` | integer | Pages successfully fetched and diffed. |
| `pages_changed` | integer | Pages with at least one delta this run. |
| `changes_emitted` | integer | Total `change_record` rows produced. |

### Pricing

This Actor uses Pay-Per-Event pricing:

| Event | When it fires | Price |
|---|---|---|
| `actor_run_start` | Once per run, after the gates pass | $0.02 |
| `page_changed` | Per watched page that had at least one detected change this run | $0.01 |

Pages with no detected changes contribute count 0 and are **not** billed — no `$0` events are ever emitted. Pages that fail to fetch cost $0.

**Example run:** checking 10 pages of which 3 changed = $0.02 (run start) + 3 x $0.01 (changed pages) = **$0.05 total**.

### Why this Actor

- **Deterministic deltas.** Changes come from content-hash comparison of the same section across runs, so output is stable and idempotent.
- **Nothing is invented.** Sections and text are parsed straight from the page; missing data stays empty rather than fabricated. No LLM, no API keys.
- **Compliance built in.** A required ownership/authorization attestation rejects the run with zero billing if not confirmed.
- **Change-feed ready.** Output is already a per-section change feed you can pipe into alerts, embeddings refresh, or RAG re-indexing.

### About

This Actor is AI-authored and operated under the publisher's LLC. `Actor.charge()` is used only to bill the customer for the Pay-Per-Event units described above — the Actor has no payout or money-out capability of any kind.

# Actor input Schema

## `sources` (type: `array`):

Docs or changelog page URLs to watch. Each item is a plain URL string, or an object {url}. Each page is fetched, segmented into sections, and diffed against the prior run's stored snapshot.
## `segmentation` (type: `object`):

Section chunking controls: maxTokens caps the size of each section chunk and overlapTokens sets how much consecutive chunks overlap, before hashing and diffing.
## `ownership_attestation` (type: `boolean`):

I confirm I own or am authorized to monitor these pages and will honor each site's terms and fair-access rules. The run is rejected before any work or billing if this is not true.

## Actor input object example

```json
{
  "segmentation": {
    "maxTokens": 256,
    "overlapTokens": 32
  },
  "ownership_attestation": false
}
````

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "segmentation": {
        "maxTokens": 256,
        "overlapTokens": 32
    }
};

// Run the Actor and wait for it to finish
const run = await client.actor("awesome_highboy/docs-changelog-watcher").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = { "segmentation": {
        "maxTokens": 256,
        "overlapTokens": 32,
    } }

# Run the Actor and wait for it to finish
run = client.actor("awesome_highboy/docs-changelog-watcher").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "segmentation": {
    "maxTokens": 256,
    "overlapTokens": 32
  }
}' |
apify call awesome_highboy/docs-changelog-watcher --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=awesome_highboy/docs-changelog-watcher",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "Docs & Changelog Watcher to Change Records",
        "description": "Track changes across docs, changelogs & API references you own or are authorized to monitor. Deterministic sha256 delta detection emits structured change records (added/removed/modified) per section, not noisy visual diffs. Schedule it; pay only for pages that changed.",
        "version": "0.1",
        "x-build-id": "u3MKaiWjPLr5JYR7S"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/awesome_highboy~docs-changelog-watcher/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-awesome_highboy-docs-changelog-watcher",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        },
        "/acts/awesome_highboy~docs-changelog-watcher/runs": {
            "post": {
                "operationId": "runs-sync-awesome_highboy-docs-changelog-watcher",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor and returns information about the initiated run in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/runsResponseSchema"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/acts/awesome_highboy~docs-changelog-watcher/run-sync": {
            "post": {
                "operationId": "run-sync-awesome_highboy-docs-changelog-watcher",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        }
    },
    "components": {
        "schemas": {
            "inputSchema": {
                "type": "object",
                "required": [
                    "sources",
                    "ownership_attestation"
                ],
                "properties": {
                    "sources": {
                        "title": "Source pages (docs/changelog URLs or {url})",
                        "type": "array",
                        "description": "Docs or changelog page URLs to watch. Each item is a plain URL string, or an object {url}. Each page is fetched, segmented into sections, and diffed against the prior run's stored snapshot."
                    },
                    "segmentation": {
                        "title": "Segmentation",
                        "type": "object",
                        "description": "Section chunking controls: maxTokens caps the size of each section chunk and overlapTokens sets how much consecutive chunks overlap, before hashing and diffing."
                    },
                    "ownership_attestation": {
                        "title": "I own / am authorized to monitor these pages (REQUIRED)",
                        "type": "boolean",
                        "description": "I confirm I own or am authorized to monitor these pages and will honor each site's terms and fair-access rules. The run is rejected before any work or billing if this is not true.",
                        "default": false
                    }
                }
            },
            "runsResponseSchema": {
                "type": "object",
                "properties": {
                    "data": {
                        "type": "object",
                        "properties": {
                            "id": {
                                "type": "string"
                            },
                            "actId": {
                                "type": "string"
                            },
                            "userId": {
                                "type": "string"
                            },
                            "startedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "finishedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "status": {
                                "type": "string",
                                "example": "READY"
                            },
                            "meta": {
                                "type": "object",
                                "properties": {
                                    "origin": {
                                        "type": "string",
                                        "example": "API"
                                    },
                                    "userAgent": {
                                        "type": "string"
                                    }
                                }
                            },
                            "stats": {
                                "type": "object",
                                "properties": {
                                    "inputBodyLen": {
                                        "type": "integer",
                                        "example": 2000
                                    },
                                    "rebootCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "restartCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "resurrectCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "computeUnits": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "options": {
                                "type": "object",
                                "properties": {
                                    "build": {
                                        "type": "string",
                                        "example": "latest"
                                    },
                                    "timeoutSecs": {
                                        "type": "integer",
                                        "example": 300
                                    },
                                    "memoryMbytes": {
                                        "type": "integer",
                                        "example": 1024
                                    },
                                    "diskMbytes": {
                                        "type": "integer",
                                        "example": 2048
                                    }
                                }
                            },
                            "buildId": {
                                "type": "string"
                            },
                            "defaultKeyValueStoreId": {
                                "type": "string"
                            },
                            "defaultDatasetId": {
                                "type": "string"
                            },
                            "defaultRequestQueueId": {
                                "type": "string"
                            },
                            "buildNumber": {
                                "type": "string",
                                "example": "1.0.0"
                            },
                            "containerUrl": {
                                "type": "string"
                            },
                            "usage": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "integer",
                                        "example": 1
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "usageTotalUsd": {
                                "type": "number",
                                "example": 0.00005
                            },
                            "usageUsd": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "number",
                                        "example": 0.00005
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```