Peter Steinberger
7f2b962c92
docs: refresh for renamed APIs and new stores
...
Sync the docs site with recent source changes:
- json: writeJsonAtomic/writeTextAtomic → writeJson/writeText; readJsonFile/Strict
→ readJson + readJsonIfExists + tryReadJson; ensureDirMode → dirMode;
appendTrailingNewline → trailingNewline.
- temp: createPrivateTempWorkspace/createTempFileTarget → tempWorkspace/tempFile;
PrivateTempWorkspaceOptions → TempWorkspaceOptions; TempFileTarget → TempFile.
- atomic: replaceDirectoryStaged → replaceDirectoryAtomic; mode/dirMode names.
- root: read{Path → Absolute}; RootDefaults gains mode; per-method options pick
mode through RootWriteOptions / RootCopyOptions / RootOpenWritableOptions.
- secret-file: writePrivateSecretFileAtomic gains mode/dirMode and now requires
rootDir; documents the asserted-mode behavior on each component.
- sidecar-lock: SidecarLockHandle has [Symbol.asyncDispose]; document the new
top-level withSidecarLock helper.
New pages:
- file-store.md — fileStore() + copyIntoRoot.
- json-store.md — jsonStore<T>() with optional cross-process lock.
Add a "Stores" section to the sidebar; update install.md subpath table to list
json-store, file-store, and local-roots.
2026-05-05 19:30:54 +01:00
Peter Steinberger
a559283ac5
docs: add fs-safe.io documentation site
...
- 25 markdown guides covering every public primitive: root(), pathScope(),
reading/writing, atomic writes, JSON, temp workspaces, archive extraction,
secret files, sidecar locks, pinned open, local roots, path/filename helpers,
install paths, errors, types, testing, timing, contributing.
- Custom Node-based static site generator (scripts/build-docs-site.mjs) with
link validation, dark mode, mobile nav, search, copy buttons.
- GitHub Actions workflow deploys to Pages on docs/script changes.
- CNAME points to fs-safe.io (DNS already configured to GitHub Pages IPs).
To activate: switch repo Pages source from legacy/branch to workflow.
2026-05-05 17:57:31 +01:00
