From 1a2745579e8385d11abe8c7c666cfc21d4d2a1d1 Mon Sep 17 00:00:00 2001 From: sudacode Date: Wed, 11 Mar 2026 02:13:01 -0700 Subject: [PATCH] Clarify Yomitan external profile path for Linux GSM overlay - Document Linux GameSentenceMiner overlay default: `~/.config/gsm_overlay` - Add inline example for `yomitan.externalProfilePath` in integration option docs --- config.example.jsonc | 2 +- docs-site/public/config.example.jsonc | 2 +- src/config/definitions/options-integrations.ts | 2 +- src/config/definitions/template-sections.ts | 1 + 4 files changed, 4 insertions(+), 3 deletions(-) diff --git a/config.example.jsonc b/config.example.jsonc index 23a57d34..c1ce0eee 100644 --- a/config.example.jsonc +++ b/config.example.jsonc @@ -389,7 +389,7 @@ // Yomitan // Optional external Yomitan profile integration. // Setting yomitan.externalProfilePath switches SubMiner to read-only external-profile mode. - // For GameSentenceMiner, the default Linux overlay profile is usually ~/.config/gsm_overlay. + // For GameSentenceMiner on Linux, the default overlay profile is usually ~/.config/gsm_overlay. // In external-profile mode SubMiner will not import, delete, or modify Yomitan dictionaries/settings. // ========================================== "yomitan": { diff --git a/docs-site/public/config.example.jsonc b/docs-site/public/config.example.jsonc index 23a57d34..c1ce0eee 100644 --- a/docs-site/public/config.example.jsonc +++ b/docs-site/public/config.example.jsonc @@ -389,7 +389,7 @@ // Yomitan // Optional external Yomitan profile integration. // Setting yomitan.externalProfilePath switches SubMiner to read-only external-profile mode. - // For GameSentenceMiner, the default Linux overlay profile is usually ~/.config/gsm_overlay. + // For GameSentenceMiner on Linux, the default overlay profile is usually ~/.config/gsm_overlay. // In external-profile mode SubMiner will not import, delete, or modify Yomitan dictionaries/settings. // ========================================== "yomitan": { diff --git a/src/config/definitions/options-integrations.ts b/src/config/definitions/options-integrations.ts index 4ba11f63..91947c6b 100644 --- a/src/config/definitions/options-integrations.ts +++ b/src/config/definitions/options-integrations.ts @@ -216,7 +216,7 @@ export function buildIntegrationConfigOptionRegistry( kind: 'string', defaultValue: defaultConfig.yomitan.externalProfilePath, description: - 'Optional external Yomitan Electron profile path to use in read-only mode for shared dictionaries/settings.', + 'Optional external Yomitan Electron profile path to use in read-only mode for shared dictionaries/settings. Example: ~/.config/gsm_overlay', }, { path: 'jellyfin.enabled', diff --git a/src/config/definitions/template-sections.ts b/src/config/definitions/template-sections.ts index 91791dee..d25e8d1b 100644 --- a/src/config/definitions/template-sections.ts +++ b/src/config/definitions/template-sections.ts @@ -142,6 +142,7 @@ const INTEGRATION_TEMPLATE_SECTIONS: ConfigTemplateSection[] = [ description: [ 'Optional external Yomitan profile integration.', 'Setting yomitan.externalProfilePath switches SubMiner to read-only external-profile mode.', + 'For GameSentenceMiner on Linux, the default overlay profile is usually ~/.config/gsm_overlay.', 'In external-profile mode SubMiner will not import, delete, or modify Yomitan dictionaries/settings.', ], key: 'yomitan',