Skip to content

docs: replace obsolete PauseActor and paused actor references - #2926

Merged
Haven Xia (HavenXia) merged 1 commit into
agent-substrate:mainfrom
zoez7:remove-pause-docs
Oct 21, 2026
Merged

Haven Xia (HavenXia) merged 1 commit into
agent-substrate:mainfrom
zoez7:remove-pause-docs

Conversation

@zoez7

@zoez7 Zoe Zhao (zoez7) commented Oct 19, 2026 •

Copy link
Copy Markdown
Collaborator

Depends on #2883, which makes a synchronous suspend record locality and keep assigned_node. The docs here describe that behavior after it merges.

Summary

Following the removal of PauseActor in #2813 and defaulting SuspendActor to asynchronous mode in #2805, update documentation, protobuf comments (and generated code), production Go comments, and test/benchmark comments across the repository that still referred to PauseActor or "paused" actors.

Key Updates

  • Documentation (docs/):
    • Remove the standalone Pause glossary entry in docs/glossary.md and update Actor, Checkpoint, Restore, and Suspend definitions to describe SuspendActor's two durability modes (DURABILITY_MODE_SYNCHRONOUS and DURABILITY_MODE_ASYNCHRONOUS, with async as the default) and clarify that snapshots are always uploaded to object storage.
    • Update docs/api-guide.md, docs/architecture.md, docs/api-style-guide.md, docs/authorization.md, docs/observability.md, and docs/metrics/registry/metrics.yaml to describe synchronous vs. asynchronous SuspendActor and node-local snapshot pinning instead of PauseActor.
  • Protobuf & Generated Code (pkg/proto/ateapipb/, internal/proto/ateletpb/):
    • Update comments on SuspendActor, RevertActor, DeleteSnapshotTag, ActorStatus.assigned_node, Snapshot.locality, and ateletpb RPCs; regenerate *.pb.go and *_grpc.pb.go.
  • Production Code & Tests (internal/, cmd/ateapi/, cmd/atelet/, benchmarking/):
    • Update comments and error message hints referring to PauseActor or "paused" actors to reflect asynchronous SuspendActor and node-local snapshots.

Comment thread cmd/ateapi/internal/controlapi/workflow_suspend.go Outdated
Comment thread docs/architecture.md
Comment thread pkg/proto/ateapipb/ateapi.proto Outdated
Comment thread docs/api-guide.md Outdated
Comment thread docs/glossary.md
@zoez7
Zoe Zhao (zoez7) force-pushed the remove-pause-docs branch 2 times, most recently from 4f1b1aa to a22a3cd Compare October 20, 2026 17:52
Comment thread docs/observability.md Outdated
Comment thread docs/api-guide.md Outdated
Comment thread docs/architecture.md
Comment thread cmd/ateapi/internal/controlapi/workflow_suspend.go Outdated
Comment thread pkg/proto/ateapipb/ateapi.proto Outdated
Comment thread docs/glossary.md
Comment thread docs/api-guide.md
Comment thread docs/observability.md Outdated
@msau42

Michelle Au (msau42) commented Oct 21, 2026 •

Copy link
Copy Markdown
Collaborator

nit: the commit messge includes some conflict resolution markers

# Conflicts:
#	cmd/atelet/metrics.go
#	docs/metrics/registry/metrics.yaml
#	docs/observability.md

PauseActor was removed in favor of SuspendActor with two durability modes (DURABILITY_MODE_SYNCHRONOUS and DURABILITY_MODE_ASYNCHRONOUS, with asynchronous as the default). Both modes keep a local snapshot on the node (locality set) and upload the snapshot to object storage, differing in when the upload finishes (before SuspendActor returns vs. in the background).

Update documentation, protobuf comments (and generated code), production Go comments, and test/benchmark comments across the repository to describe synchronous and asynchronous SuspendActor, node-local snapshots, and detach on resume instead of PauseActor or paused actors.
@HavenXia
Haven Xia (HavenXia) added this pull request to the merge queue Oct 21, 2026
Merged via the queue into agent-substrate:main with commit c9d9753 Oct 21, 2026
15 checks passed
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.

4 participants