Skip to content

docs: add TODO.md, the tracked list of planned work - #13

Merged
psyinf merged 1 commit into
mainfrom
docs/todo
Sep 19, 2026
Merged

psyinf merged 1 commit into
mainfrom
docs/todo

Conversation

@psyinf

@psyinf psyinf commented Sep 17, 2026

Copy link
Copy Markdown
Owner

Collects the open extension ideas in one file, so planned work has a single
place to live and PRs can refer to an item instead of restating the design.

TODO.md lists, in overview and then one section each:

  1. More examples for the newer featuresGraphContext, finish(), a
    stateful merge, JoinFilter, a nested graph, a Void sink, the in-band tick
    pattern. The follow-up PR to this one.
  2. Named merge slots(raw: msg, checked: valid) -> Summarize.
  3. Several named graph inputsin.orders, in.quotes, mirroring
    GraphOutputs.
  4. Stage labels and typed accessSummarize@stats, graph.stage<T>("stats").
  5. Track which stage short-circuited — moved here from the README roadmap.
  6. Config-aware registerMergeFilter — a fresh combiner per instance.
  7. Injectable registry, duplicate detection — instead of a singleton that
    silently overwrites.
  8. Documentation — 0..n outputs, fan-out copies, stateful stages.
  9. Known limitations to lift — nested stage arguments in the DSL, type
    checking inside GraphOutputs.

Each item states what the library does today, the design gap, a proposal with an
API sketch, its compatibility impact and the workaround available in the
meantime. Nothing in it is implemented; the two items of the original list
that have shipped (type-checked merge inputs, finish()) are named as done and
left to the README.

The README roadmap section now summarizes the list and links to it.

Docs only: no library, app or test code changes.

Collects the open extension ideas in one place: more examples for the
newer features, named merge slots, several named graph inputs, stage
labels with typed access, tracking which stage short-circuited, a
config-aware registerMergeFilter, an injectable registry with duplicate
detection, the documentation items around 0..n outputs and large
messages, and the two limitations the README lists.

Each item says what the library does today, the gap, a proposal with an
API sketch, its compatibility impact and the workaround available in the
meantime. Nothing here is implemented.

The README roadmap now summarizes the list and links to it; its
short-circuit item moved into TODO.md unchanged.
@psyinf
psyinf merged commit d24e710 into main Sep 19, 2026
3 checks passed
@psyinf
psyinf deleted the docs/todo branch September 19, 2026 19:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant