agent-substrate / agent-substrate/substrate

Document lifecycle and RPC details in docstrings near the code

Offen
#236 1 Kommentar 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen
area/api kind/docs
Vorherrschende Sprache
Go
Sterne
1.8k
Forks
316
Ø Merge
2 T. 43 Min.
Gemergte PRs (30 T.)
287

Beschreibung

In review of #200, @bowei suggested keeping the glossary at a high level and locating detailed definitions as close to the code as possible:

> Can we keep the glossary definitions to be summaries at the high level? More low level descriptions should be kept as close to the code definitions as possible (i.e. in docstrings) so there are less consistency issues.

The glossary is being slimmed accordingly. Some of the removed detail is worth capturing in docstrings so it has a durable home:

- **Actor lifecycle states**: document the `SUSPENDED` → `RESUMING` → `RUNNING` → `SUSPENDING` → `SUSPENDED` transitions on the status enum / state type itself.
- **Control service RPCs**: the semantics of `CreateActor`, `ResumeActor`, `SuspendActor`, and `DeleteActor` belong in the proto/service definitions.
- **ateom workload RPCs**: `RunWorkload`, `CheckpointWorkload`, `RestoreWorkload`, and the atelet↔ateom contract (gRPC over unix socket) belong on the ateom service definition.
- **runsc invocation details**: how the sandbox is created/started/checkpointed/restored, and the per-`ActorTemplate` binary pinning (URL + SHA-256), belong with the code that drives `runsc`.

The goal is a single source of truth per definition: the glossary gives a one-to-three-sentence summary of each Substrate-specific term, while anything mechanical lives in a docstring where it gets updated alongside the code it describes.

Beitragsleitfaden

Beitragsleitfaden öffnen

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.