Skip to content

docs: rewrite README and samples for Data Plane Signaling v1.0 - #26

Merged
paullatzelsperger merged 1 commit into
mainfrom
docs/readme-examples-v1
Nov 10, 2026
Merged

paullatzelsperger merged 1 commit into
mainfrom
docs/readme-examples-v1

Conversation

@paullatzelsperger

Copy link
Copy Markdown
Contributor

Phase 8, the last step of the signaling v1.0 migration: docs, samples and end-to-end tests. No SDK behaviour changes.

  • README rewritten for the v1.0 API (quick start, endpoints, processors and state machine, callbacks, registration, authorization, storage, examples).
  • Samples: one shared sample control plane server (callbacks, data plane registration, demo authorization); all samples register in both directions; sync-pull completes via NotifyCompleted. Fixes a startup race in the sync-pull launcher.
  • End-to-end tests: provider-push and consumer-pull, sync and async, full lifecycle through NewHandler with a fake control plane, plus a Postgres-backed run.
  • Package docs (doc.go) and missing godoc; stale pre-migration names removed.
  • Removes a sample binary that was committed by accident in feat: migrate to Data Plane Signaling v1.0 (wire model, router, storage) #22 and ignores the example binaries.

🤖 Generated with Claude Code

- README rewritten for the current API: endpoints, processors and the
  state machine, callbacks, registration, authorization, storage,
  examples and testing
- examples/controlplane is a real sample control plane server
  (registration and callback endpoints) shared by all samples; every
  sample registers in both directions, sync-pull completes with a
  data-plane-initiated NotifyCompleted
- fix a startup race in the sync-pull launcher
- end-to-end tests for push and pull, sync and async, with two SDKs and
  a fake control plane over HTTP, plus a Postgres-backed variant
- package docs (doc.go) and missing godoc
- stop tracking a compiled sample binary and ignore example binaries

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@paullatzelsperger
paullatzelsperger merged commit 237d3d6 into main Nov 10, 2026
6 checks passed
@paullatzelsperger
paullatzelsperger deleted the docs/readme-examples-v1 branch November 10, 2026 11:30
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.

2 participants