Skip to content

docs(settings): correct project storage descriptions #459

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SaKaNa-Y wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs(settings): correct project storage descriptions #459

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1f8261d
docs(settings): correct project storage descriptions
SaKaNa-Y Oct 25, 2026
e9c5aaf
docs(settings): use canonical storage terminology
SaKaNa-Y Oct 26, 2026
36a2d15
docs(settings): keep storage correction minimal
SaKaNa-Y Oct 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/content/1.guide/7.scoped-context.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Bare names stay typed: `call('get-modules')` resolves to your [RPC registry](/gu

`my.settings` is a persisted key-value store (alongside `my.rpc`), with two scopes:

- **`project`**: per-checkout values, under the `workspace` storage dir.
- **`project`**: per-checkout values, under the `project` storage dir.
- **`global`**: per-user values, under the `global` storage dir.

Both are file-backed and synced to the browser over the shared-state protocol; a `set` propagates to peers, surviving restarts.
Expand Down
4 changes: 2 additions & 2 deletions packages/devframe/src/types/scope.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,8 @@ export interface DevframeSettingsStore<T extends Record<string, any> = Record<st
/**
* The two settings scopes available on a scoped context.
*
* - `project`: per-workspace state, persisted under the host's
* `workspace` storage dir. Project-local settings.
* - `project`: per-checkout state, persisted under the
* `project` storage dir. Project-local settings.
* - `global`: per-user state, persisted under the host's `global`
* storage dir. Machine-wide preferences.
*/
Expand Down
Loading