aboutsummaryrefslogtreecommitdiffstats
path: root/docs/architecture.md
diff options
context:
space:
mode:
authorLibravatar Kristóf Marussy <kristof@marussy.com>2022-04-26 02:36:02 +0200
committerLibravatar Kristóf Marussy <kristof@marussy.com>2022-05-16 00:55:02 +0200
commit71082348b5d7105945bda90b097aef0a58ea35d9 (patch)
treee4f0115905cfbf4d76a1e0bc03d7815d0925b318 /docs/architecture.md
parentchore(deps): remove ms to reduce dependency count (diff)
downloadsophie-71082348b5d7105945bda90b097aef0a58ea35d9.tar.gz
sophie-71082348b5d7105945bda90b097aef0a58ea35d9.tar.zst
sophie-71082348b5d7105945bda90b097aef0a58ea35d9.zip
refactor: remove json5 dependency
Use a more standard config file format and reduce the amount of external code running in the security-sensitive context of the main process. Signed-off-by: Kristóf Marussy <kristof@marussy.com>
Diffstat (limited to 'docs/architecture.md')
-rw-r--r--docs/architecture.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/architecture.md b/docs/architecture.md
index b76b2ff..8b61288 100644
--- a/docs/architecture.md
+++ b/docs/architecture.md
@@ -69,7 +69,7 @@ Within the `MainStore`, changes to the [`SharedStore`](https://gitlab.com/say-hi
69Thus it can hold application state relevant to displaying the UI. 69Thus it can hold application state relevant to displaying the UI.
70 70
71The [`Config`](https://gitlab.com/say-hi-to-sophie/sophie/-/blob/main/packages/shared/src/stores/Config.ts) in the `SharedStore` holds the application configuration, including the list of services to be displayed. 71The [`Config`](https://gitlab.com/say-hi-to-sophie/sophie/-/blob/main/packages/shared/src/stores/Config.ts) in the `SharedStore` holds the application configuration, including the list of services to be displayed.
72It is synchronized with the `config.json5` file in user data directory, which should be human-readable and -editable to facilitate debugging and other advanced use cases. 72It is synchronized with the `settings.json` file in user data directory, which should be human-readable and -editable to facilitate debugging and other advanced use cases.
73 73
74In the UI renderer process, the [`RendererStore`](https://gitlab.com/say-hi-to-sophie/sophie/-/blob/main/packages/renderer/src/stores/RendererStore.ts) hold the UI sate. 74In the UI renderer process, the [`RendererStore`](https://gitlab.com/say-hi-to-sophie/sophie/-/blob/main/packages/renderer/src/stores/RendererStore.ts) hold the UI sate.
75It contains a read-only copy of the `SharedStore`. 75It contains a read-only copy of the `SharedStore`.