Skip to content

docs: agent storage loop + agent-state encryption#336

Merged
ducnmm merged 10 commits into
MystenLabs:devfrom
reemsabawi-mystenlabs:reemsabawi/bedu-611-example-full-agent-storage-loop-on-testnet
Jun 30, 2026
Merged

docs: agent storage loop + agent-state encryption#336
ducnmm merged 10 commits into
MystenLabs:devfrom
reemsabawi-mystenlabs:reemsabawi/bedu-611-example-full-agent-storage-loop-on-testnet

Conversation

@reemsabawi-mystenlabs

@reemsabawi-mystenlabs reemsabawi-mystenlabs commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Adds the agent storage loop, agent-state encryption, and production-readiness guides for autonomous agents. Closes BEDU-611, BEDU-604, BEDU-762, BEDU-763, BEDU-765.

Adds a headless agent storage loop walkthrough on Testnet (BEDU-611) covering
env-only setup (BEDU-604), batched writes with Quilt (BEDU-762), and client-side
SEAL encryption (BEDU-763). Extends MemWalManual docs with an agent-state /
key-management section and registers the new page in docs.json.
Comment thread docs/sdk/usage/memwal-manual.md Outdated
Comment thread docs/sdk/usage/memwal-manual.md Outdated
Comment thread docs/sdk/usage/memwal-manual.md Outdated
Comment thread docs/sdk/usage/memwal-manual.md Outdated
Comment thread docs/sdk/agent-storage-loop.md Outdated
Comment thread docs/sdk/agent-storage-loop.md Outdated
Comment thread docs/sdk/agent-storage-loop.md Outdated
reemsabawi-mystenlabs and others added 7 commits June 26, 2026 13:20
Patterns for running an agent in production: idempotent writes, retries with backoff, durability confirmation, cost bounding, key custody, graceful degradation, and the recall result cap (BEDU-765).
Co-authored-by: Jessie Mongeon <133128541+jessiemongeon1@users.noreply.github.com>
Co-authored-by: Jessie Mongeon <133128541+jessiemongeon1@users.noreply.github.com>
Co-authored-by: Jessie Mongeon <133128541+jessiemongeon1@users.noreply.github.com>
Co-authored-by: Jessie Mongeon <133128541+jessiemongeon1@users.noreply.github.com>
Co-authored-by: Jessie Mongeon <133128541+jessiemongeon1@users.noreply.github.com>
Co-authored-by: Jessie Mongeon <133128541+jessiemongeon1@users.noreply.github.com>
@jessiemongeon1

Copy link
Copy Markdown
Contributor

Style Guide Audit

Audited 3 file(s) against the Sui Documentation Style Guide.

25 violation(s) found. All must be fixed before merge.

docs/sdk/agent-storage-loop.md (7 violation(s))

7 violation(s) (1 regex, 6 claude)

  • Line 104 — Use "might" not "may"
    • Current: may
    • Fix: might
  • Line 78 — passive_voice
    • Current: private agent state must be encrypted
    • Fix: you must encrypt private agent state
  • Line 104 — passive_voice
    • Current: the encrypted memories cannot be recovered
    • Fix: you cannot recover the encrypted memories
  • Line 111 — passive_voice
    • Current: the write persisted, confirm the write reached
    • Fix: the write persisted, confirm that the write reached
  • Line 134 — passive_voice
    • Current: With writes confirmed, recall pulls the relevant memories back
    • Fix: After you confirm the writes, recall pulls the relevant memories back
  • Line 80 — passive_voice
    • Current: the relayer encrypts every item with Seal before it reaches Walrus. You do not manage keys, and this is the right default
    • Fix: Rewrite: the relayer encrypts every item with Seal before it reaches Walrus. You do not manage keys, making this the right default
  • Line 113 — passive_voice
    • Current: the memory was embedded, encrypted, and uploaded to Walrus
    • Fix: the relayer embedded, encrypted, and uploaded the memory to Walrus

docs/sdk/production-readiness.md (12 violation(s))

12 violation(s) (7 regex, 5 claude)

  • Line 36 — Use present tense, not future
    • Current: will
    • Fix: Use present tense verb
  • Line 79 — Use "might" not "may"
    • Current: may
    • Fix: might
  • Line 89 — Use present tense, not future
    • Current: will
    • Fix: Use present tense verb
  • Line 106 — Use present tense, not future
    • Current: will
    • Fix: Use present tense verb
  • Line 111 — Use "might" not "may"
    • Current: may
    • Fix: might
  • Line 137 — Use "basic" not "simple"
    • Current: simply
    • Fix: (remove)
  • Line 137 — Use "might" not "may"
    • Current: may
    • Fix: might
  • Line 13 — passive_voice
    • Current: A remember call that is retried after a network blip
    • Fix: A remember call that retries after a network blip
  • Line 66 — passive_voice
    • Current: that assumes a write persisted until it has confirmed the write reached a terminal state
    • Fix: that assumes a write persisted until it confirms the write reached a terminal state
  • Line 79 — passive_voice
    • Current: confirms the memory was stored
    • Fix: confirms that the client stored the memory
  • Line 137 — passive_voice
    • Current: the extra results are simply not returned
    • Fix: the system simply does not return the extra results
  • Line 137 — passive_voice
    • Current: the set was truncated
    • Fix: the system truncated the set

docs/sdk/usage/memwal-manual.md (6 violation(s))

6 violation(s) (3 regex, 3 claude)

  • Line 10 — Use "because" not causal "since"
    • Current: since
    • Fix: because
  • Line 18 — Use "through" not "via"
    • Current: via
    • Fix: through
  • Line 139 — Use "might" not "may"
    • Current: may
    • Fix: might
  • Line 106 — passive_voice
    • Current: private agent state must be encrypted before it is stored
    • Fix: you must encrypt private agent state before storing it
  • Line 139 — passive_voice
    • Current: the encrypted memories cannot be recovered
    • Fix: you cannot recover the encrypted memories
  • Line 139 — passive_voice
    • Current: if it may be exposed
    • Fix: if it is at risk of exposure

Automated audit using the Sui Documentation Style Guide.

ducnmm added 2 commits June 30, 2026 09:13
…revert manual table to em-dashes

- agent-storage-loop: replace misleading '2N+K' tx-count with accurate framing; passive-voice + may/might fixes
- production-readiness: present-tense, may/might, passive-voice, drop 'simply'
- memwal-manual: since->because, via->through, passive-voice; restore '—' over 'n/a' per review
…ample-full-agent-storage-loop-on-testnet

# Conflicts:
#	docs/docs.json

@ducnmm ducnmm left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs review: verified SDK examples (rememberBulk/recall/MemWalManual) against packages/sdk, applied style-guide fixes and review suggestions, corrected the batched-write cost description, and resolved the docs.json sidebar conflict. LGTM.

@ducnmm ducnmm merged commit 45fbfa9 into MystenLabs:dev Jun 30, 2026
7 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.

3 participants