docs(store): clarify declarative constructor guidance

Co-Authored-By: Virgil <virgil@lethean.io>
This commit is contained in:
Virgil 2026-04-04 10:29:56 +00:00
parent 089f80c087
commit 4e6a97c119

5
doc.go
View file

@ -5,8 +5,9 @@
// 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.
// Use `store.NewConfigured(store.StoreConfig{...})` when the database path,
// journal, and purge interval are already known.
// Keep `store.New(..., store.WithJournal(...))` for incremental assembly.
//
// Usage example:
//