tegwick
1208f0f0ee
The generated index had drifted from the workplan files. The opt-in lets the pre-commit hook rebuild WORK-RECORDS.md in the same commit as the workplan it indexes. Assistant: grok Assistant-Session: 01a17f9d-fe9d-7d72-9a22-6304f1a2a790
51 lines
2.1 KiB
Markdown
51 lines
2.1 KiB
Markdown
# SCOPE
|
|
|
|
## One-liner
|
|
|
|
Keeps material delivered to the ecosystem and routes it by topic to the repositories that asked to see it.
|
|
|
|
## Core Idea
|
|
|
|
See INTENT.md. Email and registered sources go into an append-only, content-addressed
|
|
item store. File-backed registries of topics, sources and subscriptions decide
|
|
who is told about each item. Notices reach consumers as State Hub agent messages,
|
|
through a pull CLI, and in periodic digest files.
|
|
|
|
## In Scope
|
|
|
|
- Read-only IMAP intake from one dedicated mailbox.
|
|
- Items with original bytes, provenance and derived text; integrity checking.
|
|
- Registries of topics, sources (including sources contributed by consumers) and subscriptions.
|
|
- Matching, idempotent notices, pull access, digest files.
|
|
- Scheduling, health reporting and quarantine on the workstation, later in the cluster.
|
|
|
|
## Out of Scope
|
|
|
|
- Sending mail other than notices. email-connect owns email delivery and its evidence.
|
|
- Scraping signed-in websites, or any intake that breaks a provider's terms of service.
|
|
- Judging whether material is relevant or credible. Consumers review it.
|
|
- Replacing a consumer's own evidence store.
|
|
|
|
## Current State
|
|
|
|
- Status: inception. INTENT drafted 2026-10-05, no code yet.
|
|
- First consumer: intelligence-radar (Grok and ChatGPT daily and weekly briefs).
|
|
|
|
## Getting Oriented
|
|
|
|
- Start with: INTENT.md
|
|
- Agent instructions: AGENTS.md
|
|
- Workplans: workplans/
|
|
|
|
## Generated work-record index
|
|
|
|
This repository opts into staged-source WORK-RECORDS.md generation through
|
|
`.generated-work-records.json` and the isolated `.generated-work-records.mk`
|
|
recipe. `make generated-work-records` reuses the State Hub renderer through
|
|
the Custodian adapter; `make generated-work-records-check` verifies byte-exact
|
|
agreement with staged Markdown. The pre-commit hook uses the isolated recipe,
|
|
preserves unstaged index edits by refusing them, and retains the generated-only
|
|
commit guard. It does not contact the hub, alter workplan statuses, or grant
|
|
deployment authority. This consumes shared tooling; it does not make this
|
|
repository the provider of the generator capability.
|
|
|