refactor(store): align workspace docs with AX
Co-Authored-By: Virgil <virgil@lethean.io>
This commit is contained in:
parent
af0e677d65
commit
1b5f59ebc5
2 changed files with 5 additions and 1 deletions
3
doc.go
3
doc.go
|
|
@ -2,6 +2,9 @@
|
|||
// namespace isolation, quota enforcement, reactive change notifications,
|
||||
// workspace journalling, and explicit orphan recovery.
|
||||
//
|
||||
// Workspace files are created under `.core/state/` and can be recovered with
|
||||
// `RecoverOrphans(".core/state")`.
|
||||
//
|
||||
// Prefer `store.NewConfigured(store.StoreConfig{...})` when constructing a
|
||||
// store from an agent-written configuration literal.
|
||||
//
|
||||
|
|
|
|||
|
|
@ -32,7 +32,8 @@ FROM workspace_entries`
|
|||
|
||||
var defaultWorkspaceStateDirectory = ".core/state"
|
||||
|
||||
// Workspace buffers mutable work-in-progress in a temporary database file.
|
||||
// Workspace buffers mutable work-in-progress in `.core/state/scroll-session.duckdb`
|
||||
// until Commit or Discard removes the file.
|
||||
//
|
||||
// Usage example: `workspace, err := storeInstance.NewWorkspace("scroll-session-2026-03-30"); if err != nil { return }; defer workspace.Discard()`
|
||||
type Workspace struct {
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue