Skip to content

Beautiful, AI-native markdown IDE and LLM wiki

Reword open-folder onboarding dialog copy (#1950)

Andrew Mikofalvyc3c75bcfaebe
diff --git a/.changeset/consent-dialog-copy.md b/.changeset/consent-dialog-copy.md
new file mode 100644
index 000000000..67cebf76e
--- /dev/null
+++ b/.changeset/consent-dialog-copy.md
@@ -0,0 +1,5 @@
+---
+"@inkeep/open-knowledge": patch
+---
+
+Reword the open-folder onboarding dialog. The title is now "Setup Open Knowledge in this folder?" and the description reads "Open Knowledge stores its configuration and internal files inside a newly created `.ok` directory in your project root folder." The pointer to "Advanced settings" is dropped from the description; the Advanced settings section and the top-level Share-this-setup selector are unchanged.
diff --git a/packages/app/src/components/ConsentDialogBody.dom.test.tsx b/packages/app/src/components/ConsentDialogBody.dom.test.tsx
index 13c4839b6..ba9a32be0 100644
--- a/packages/app/src/components/ConsentDialogBody.dom.test.tsx
+++ b/packages/app/src/components/ConsentDialogBody.dom.test.tsx
@@ -102,6 +102,13 @@ describe('ConsentDialogBody runtime form behavior', () => {
expect(screen.queryByTestId('consent-content-dir')).toBeNull();
});
+ test('config-sharing info tooltip stays closed when the dialog first opens', async () => {
+ renderConsentDialog();
+
+ expect(screen.queryByText(/Setup files include/i)).toBeNull();
+ expect(screen.getByTestId('config-sharing-info')).not.toBe(document.activeElement);
+ });
+
test('selecting Local only carries through to the confirm payload', async () => {
const { confirmCalls } = renderConsentDialog();
diff --git a/packages/app/src/components/ConsentDialogBody.tsx b/packages/app/src/components/ConsentDialogBody.tsx
index 7f11b32cb..b400161e0 100644
--- a/packages/app/src/components/ConsentDialogBody.tsx
+++ b/packages/app/src/components/ConsentDialogBody.tsx
@@ -188,16 +188,21 @@ function ConsentDialogForm({ payload, store, toast }: ConsentDialogFormProps) {
return (
<Dialog open onOpenChange={onOpenChange}>
- <DialogContent className="sm:max-w-lg">
+ <DialogContent
+ className="sm:max-w-lg"
+ onOpenAutoFocus={(e) => {
+ e.preventDefault();
+ (e.currentTarget as HTMLElement).querySelector<HTMLElement>('[role="radio"]')?.focus();
+ }}
+ >
<DialogHeader>
<DialogTitle>
- <Trans>Open this folder with Open Knowledge</Trans>
+ <Trans>Setup Open Knowledge in this folder?</Trans>
</DialogTitle>
<DialogDescription>
<Trans>
- Open Knowledge will create a <code>.ok/</code> folder here to track this project's
- metadata and index the folder's markdown files. Review or change the details under{' '}
- <strong className="font-semibold">Advanced settings</strong> before you start.
+ Open Knowledge stores its configuration and internal files inside a newly created{' '}
+ <code>.ok</code> directory in your project root folder.
</Trans>
</DialogDescription>
</DialogHeader>
@@ -389,7 +394,7 @@ function ConsentDialogForm({ payload, store, toast }: ConsentDialogFormProps) {
<Trans>Cancel</Trans>
</Button>
<Button type="submit" form={formId} disabled={startDisabled} data-testid="consent-start">
- <Trans comment="Primary button — begins scaffolding the project">Start</Trans>
+ <Trans comment="Primary button — begins scaffolding the project">Setup</Trans>
</Button>
</DialogFooter>
</DialogContent>
diff --git a/packages/app/src/locales/en/messages.json b/packages/app/src/locales/en/messages.json
index 951c159d1..a803ab02b 100644
--- a/packages/app/src/locales/en/messages.json
+++ b/packages/app/src/locales/en/messages.json
@@ -867,6 +867,7 @@
"R65q-K": [
"A real shell is off for this project. Turning it on runs commands with the full access of your macOS user account."
],
+ "RDjuBN": ["Setup"],
"RDrXh4": ["Configure user, project, and integration settings."],
"RG4XHV": ["Copy ", ["0"], " prompt"],
"RGCCrg": ["Copy share link"],
@@ -1200,6 +1201,7 @@
"c863eW": ["Could not switch to ", ["shareBranch"], ". Try switching manually."],
"c8iK2Y": ["No templates found."],
"cEoyWz": ["Add item to ", ["keyName"]],
+ "cEx1UT": ["Setup Open Knowledge in this folder?"],
"cF9DyA": ["Reconnecting after server restart"],
"cIptmH": ["In the Claude Desktop App"],
"cKjLuT": ["(project + user)"],
@@ -1576,9 +1578,6 @@
"o5gfs1": [
"This setting is per-machine and isn't shared with collaborators. It needs an API key set with <0>ok embeddings set-key</0>."
],
- "o7htA-": [
- "Open Knowledge will create a <0>.ok/</0> folder here to track this project's metadata and index the folder's markdown files. Review or change the details under <1>Advanced settings</1> before you start."
- ],
"oBXkm2": ["Delete code block"],
"oCZkaG": ["Copy path"],
"oJl7eO": ["Unknown component: ", ["componentName"], " — source editable below"],
@@ -1605,7 +1604,6 @@
"p0Iq25": ["Insert link"],
"p9sdCy": ["New ignore pattern"],
"pAgkuZ": ["Reopening \"", ["docName"], "\" with a fresh local collaboration cache."],
- "pAlxX6": ["Open this folder with Open Knowledge"],
"pEQFsW": ["No matching projects."],
"pFagOn": ["Source editing"],
"pHYP6v": ["Open <0>Customize</0> in the sidebar <1/> <2>Skills</2>."],
@@ -1737,7 +1735,6 @@
"tP5DDk": ["Apply link"],
"tUvUfp": ["Use a folder you already have."],
"tW_yvQ": ["Expand ", ["docName"]],
- "tXkhj_": ["Start"],
"t_YqKh": ["Remove"],
"tfDRzk": ["Save"],
"tfi40B": ["Failed to create page"],
@@ -1902,6 +1899,9 @@
["typeLabel"],
" (inherited from folder properties; not editable here)"
],
+ "ygbd_U": [
+ "Open Knowledge stores its configuration and internal files inside a newly created <0>.ok</0> directory in your project root folder."
+ ],
"yjExfe": ["Branch <0>", ["shareBranch"], "</0> is checked out in:"],
"ylXj1N": ["Selected"],
"ynIa4S": ["Visual editor list item"],
diff --git a/packages/app/src/locales/en/messages.po b/packages/app/src/locales/en/messages.po
index 40a70279f..41a4815e6 100644
--- a/packages/app/src/locales/en/messages.po
+++ b/packages/app/src/locales/en/messages.po
@@ -3945,14 +3945,14 @@ msgstr "Open Knowledge is using this GitHub account."
msgid "Open Knowledge manages the <0>open-knowledge</0> MCP server name, the <1>open-knowledge-ui</1> launch config, and <2>ok</2> / <3>open-knowledge</3> on PATH (including OK-owned symlinks). Using a custom wrapper? Register it under a different name."
msgstr "Open Knowledge manages the <0>open-knowledge</0> MCP server name, the <1>open-knowledge-ui</1> launch config, and <2>ok</2> / <3>open-knowledge</3> on PATH (including OK-owned symlinks). Using a custom wrapper? Register it under a different name."
+#: src/components/ConsentDialogBody.tsx
+msgid "Open Knowledge stores its configuration and internal files inside a newly created <0>.ok</0> directory in your project root folder."
+msgstr "Open Knowledge stores its configuration and internal files inside a newly created <0>.ok</0> directory in your project root folder."
+
#: src/components/CreateProjectDialog.tsx
msgid "Open Knowledge will be initialized at <0>{gitRoot}</0> — the parent of your new folder, because it contains a <1>.git</1> folder (one project per git repo)."
msgstr "Open Knowledge will be initialized at <0>{gitRoot}</0> — the parent of your new folder, because it contains a <1>.git</1> folder (one project per git repo)."
-#: src/components/ConsentDialogBody.tsx
-msgid "Open Knowledge will create a <0>.ok/</0> folder here to track this project's metadata and index the folder's markdown files. Review or change the details under <1>Advanced settings</1> before you start."
-msgstr "Open Knowledge will create a <0>.ok/</0> folder here to track this project's metadata and index the folder's markdown files. Review or change the details under <1>Advanced settings</1> before you start."
-
#: src/components/AutoSyncEnableWarning.tsx
msgid "Open Knowledge will create commits and push them to your remote automatically. If you do not want automatic commits in your git history, you should not enable auto-sync."
msgstr "Open Knowledge will create commits and push them to your remote automatically. If you do not want automatic commits in your git history, you should not enable auto-sync."
@@ -4022,10 +4022,6 @@ msgstr "Open the Project Navigator."
msgid "Open this document in the editor and collapse the graph."
msgstr "Open this document in the editor and collapse the graph."
-#: src/components/ConsentDialogBody.tsx
-msgid "Open this folder with Open Knowledge"
-msgstr "Open this folder with Open Knowledge"
-
#: src/components/GraphPanel.tsx
msgid "Open this link in a new tab and collapse the graph."
msgstr "Open this link in a new tab and collapse the graph."
@@ -5046,10 +5042,19 @@ msgstr "Settings failed to load"
msgid "Settings sections"
msgstr "Settings sections"
+#. Primary button — begins scaffolding the project
+#: src/components/ConsentDialogBody.tsx
+msgid "Setup"
+msgstr "Setup"
+
#: src/components/ConfigSharingInfoTooltip.tsx
msgid "Setup files include: <0>.ok/</0>, AI-tool MCP configs (<1>.mcp.json</1> and per-tool files), project skills, and <2>.claude/launch.json</2>.<3/><4>Shared</4> commits them to git, so anyone who clones the repo gets the same setup. <5/><6>Local only</6> keeps them out of git (via <7>.git/info/exclude</7>)."
msgstr "Setup files include: <0>.ok/</0>, AI-tool MCP configs (<1>.mcp.json</1> and per-tool files), project skills, and <2>.claude/launch.json</2>.<3/><4>Shared</4> commits them to git, so anyone who clones the repo gets the same setup. <5/><6>Local only</6> keeps them out of git (via <7>.git/info/exclude</7>)."
+#: src/components/ConsentDialogBody.tsx
+msgid "Setup Open Knowledge in this folder?"
+msgstr "Setup Open Knowledge in this folder?"
+
#: src/components/ShareButton.tsx
msgid "Share"
msgstr "Share"
@@ -5264,11 +5269,6 @@ msgstr "Split diff"
msgid "Split list item"
msgstr "Split list item"
-#. Primary button — begins scaffolding the project
-#: src/components/ConsentDialogBody.tsx
-msgid "Start"
-msgstr "Start"
-
#: src/components/NavigatorApp.tsx
msgid "Start a new Open Knowledge project."
msgstr "Start a new Open Knowledge project."
diff --git a/packages/app/src/locales/pseudo/messages.json b/packages/app/src/locales/pseudo/messages.json
index 9c91bd4ef..a09438dec 100644
--- a/packages/app/src/locales/pseudo/messages.json
+++ b/packages/app/src/locales/pseudo/messages.json
@@ -867,6 +867,7 @@
"R65q-K": [
"À ŕēàĺ śĥēĺĺ ĩś ōƒƒ ƒōŕ ţĥĩś ƥŕōĴēćţ. Ţũŕńĩńĝ ĩţ ōń ŕũńś ćōḿḿàńďś ŵĩţĥ ţĥē ƒũĺĺ àććēśś ōƒ ŷōũŕ ḿàćŌŚ ũśēŕ àććōũńţ."
],
+ "RDjuBN": ["Śēţũƥ"],
"RDrXh4": ["Ćōńƒĩĝũŕē ũśēŕ, ƥŕōĴēćţ, àńď ĩńţēĝŕàţĩōń śēţţĩńĝś."],
"RG4XHV": ["Ćōƥŷ ", ["0"], " ƥŕōḿƥţ"],
"RGCCrg": ["Ćōƥŷ śĥàŕē ĺĩńķ"],
@@ -1200,6 +1201,7 @@
"c863eW": ["Ćōũĺď ńōţ śŵĩţćĥ ţō ", ["shareBranch"], ". Ţŕŷ śŵĩţćĥĩńĝ ḿàńũàĺĺŷ."],
"c8iK2Y": ["Ńō ţēḿƥĺàţēś ƒōũńď."],
"cEoyWz": ["Àďď ĩţēḿ ţō ", ["keyName"]],
+ "cEx1UT": ["Śēţũƥ Ōƥēń Ķńōŵĺēďĝē ĩń ţĥĩś ƒōĺďēŕ?"],
"cF9DyA": ["Ŕēćōńńēćţĩńĝ àƒţēŕ śēŕvēŕ ŕēśţàŕţ"],
"cIptmH": ["Ĩń ţĥē Ćĺàũďē Ďēśķţōƥ Àƥƥ"],
"cKjLuT": ["(ƥŕōĴēćţ + ũśēŕ)"],
@@ -1576,9 +1578,6 @@
"o5gfs1": [
"Ţĥĩś śēţţĩńĝ ĩś ƥēŕ-ḿàćĥĩńē àńď ĩśń'ţ śĥàŕēď ŵĩţĥ ćōĺĺàƀōŕàţōŕś. Ĩţ ńēēďś àń ÀƤĨ ķēŷ śēţ ŵĩţĥ <0>ōķ ēḿƀēďďĩńĝś śēţ-ķēŷ</0>."
],
- "o7htA-": [
- "Ōƥēń Ķńōŵĺēďĝē ŵĩĺĺ ćŕēàţē à <0>.ōķ/</0> ƒōĺďēŕ ĥēŕē ţō ţŕàćķ ţĥĩś ƥŕōĴēćţ'ś ḿēţàďàţà àńď ĩńďēx ţĥē ƒōĺďēŕ'ś ḿàŕķďōŵń ƒĩĺēś. Ŕēvĩēŵ ōŕ ćĥàńĝē ţĥē ďēţàĩĺś ũńďēŕ <1>Àďvàńćēď śēţţĩńĝś</1> ƀēƒōŕē ŷōũ śţàŕţ."
- ],
"oBXkm2": ["Ďēĺēţē ćōďē ƀĺōćķ"],
"oCZkaG": ["Ćōƥŷ ƥàţĥ"],
"oJl7eO": ["Ũńķńōŵń ćōḿƥōńēńţ: ", ["componentName"], " — śōũŕćē ēďĩţàƀĺē ƀēĺōŵ"],
@@ -1605,7 +1604,6 @@
"p0Iq25": ["Ĩńśēŕţ ĺĩńķ"],
"p9sdCy": ["Ńēŵ ĩĝńōŕē ƥàţţēŕń"],
"pAgkuZ": ["Ŕēōƥēńĩńĝ \"", ["docName"], "\" ŵĩţĥ à ƒŕēśĥ ĺōćàĺ ćōĺĺàƀōŕàţĩōń ćàćĥē."],
- "pAlxX6": ["Ōƥēń ţĥĩś ƒōĺďēŕ ŵĩţĥ Ōƥēń Ķńōŵĺēďĝē"],
"pEQFsW": ["Ńō ḿàţćĥĩńĝ ƥŕōĴēćţś."],
"pFagOn": ["Śōũŕćē ēďĩţĩńĝ"],
"pHYP6v": ["Ōƥēń <0>Ćũśţōḿĩźē</0> ĩń ţĥē śĩďēƀàŕ <1/> <2>Śķĩĺĺś</2>."],
@@ -1737,7 +1735,6 @@
"tP5DDk": ["Àƥƥĺŷ ĺĩńķ"],
"tUvUfp": ["Ũśē à ƒōĺďēŕ ŷōũ àĺŕēàďŷ ĥàvē."],
"tW_yvQ": ["Ēxƥàńď ", ["docName"]],
- "tXkhj_": ["Śţàŕţ"],
"t_YqKh": ["Ŕēḿōvē"],
"tfDRzk": ["Śàvē"],
"tfi40B": ["Ƒàĩĺēď ţō ćŕēàţē ƥàĝē"],
@@ -1902,6 +1899,9 @@
["typeLabel"],
" (ĩńĥēŕĩţēď ƒŕōḿ ƒōĺďēŕ ƥŕōƥēŕţĩēś; ńōţ ēďĩţàƀĺē ĥēŕē)"
],
+ "ygbd_U": [
+ "Ōƥēń Ķńōŵĺēďĝē śţōŕēś ĩţś ćōńƒĩĝũŕàţĩōń àńď ĩńţēŕńàĺ ƒĩĺēś ĩńśĩďē à ńēŵĺŷ ćŕēàţēď <0>.ōķ</0> ďĩŕēćţōŕŷ ĩń ŷōũŕ ƥŕōĴēćţ ŕōōţ ƒōĺďēŕ."
+ ],
"yjExfe": ["ßŕàńćĥ <0>", ["shareBranch"], "</0> ĩś ćĥēćķēď ōũţ ĩń:"],
"ylXj1N": ["Śēĺēćţēď"],
"ynIa4S": ["Vĩśũàĺ ēďĩţōŕ ĺĩśţ ĩţēḿ"],
diff --git a/packages/app/src/locales/pseudo/messages.po b/packages/app/src/locales/pseudo/messages.po
index 65a3f79ec..6bfac3fd3 100644
--- a/packages/app/src/locales/pseudo/messages.po
+++ b/packages/app/src/locales/pseudo/messages.po
@@ -3940,12 +3940,12 @@ msgstr ""
msgid "Open Knowledge manages the <0>open-knowledge</0> MCP server name, the <1>open-knowledge-ui</1> launch config, and <2>ok</2> / <3>open-knowledge</3> on PATH (including OK-owned symlinks). Using a custom wrapper? Register it under a different name."
msgstr ""
-#: src/components/CreateProjectDialog.tsx
-msgid "Open Knowledge will be initialized at <0>{gitRoot}</0> — the parent of your new folder, because it contains a <1>.git</1> folder (one project per git repo)."
+#: src/components/ConsentDialogBody.tsx
+msgid "Open Knowledge stores its configuration and internal files inside a newly created <0>.ok</0> directory in your project root folder."
msgstr ""
-#: src/components/ConsentDialogBody.tsx
-msgid "Open Knowledge will create a <0>.ok/</0> folder here to track this project's metadata and index the folder's markdown files. Review or change the details under <1>Advanced settings</1> before you start."
+#: src/components/CreateProjectDialog.tsx
+msgid "Open Knowledge will be initialized at <0>{gitRoot}</0> — the parent of your new folder, because it contains a <1>.git</1> folder (one project per git repo)."
msgstr ""
#: src/components/AutoSyncEnableWarning.tsx
@@ -4017,10 +4017,6 @@ msgstr ""
msgid "Open this document in the editor and collapse the graph."
msgstr ""
-#: src/components/ConsentDialogBody.tsx
-msgid "Open this folder with Open Knowledge"
-msgstr ""
-
#: src/components/GraphPanel.tsx
msgid "Open this link in a new tab and collapse the graph."
msgstr ""
@@ -5041,10 +5037,19 @@ msgstr ""
msgid "Settings sections"
msgstr ""
+#. Primary button — begins scaffolding the project
+#: src/components/ConsentDialogBody.tsx
+msgid "Setup"
+msgstr ""
+
#: src/components/ConfigSharingInfoTooltip.tsx
msgid "Setup files include: <0>.ok/</0>, AI-tool MCP configs (<1>.mcp.json</1> and per-tool files), project skills, and <2>.claude/launch.json</2>.<3/><4>Shared</4> commits them to git, so anyone who clones the repo gets the same setup. <5/><6>Local only</6> keeps them out of git (via <7>.git/info/exclude</7>)."
msgstr ""
+#: src/components/ConsentDialogBody.tsx
+msgid "Setup Open Knowledge in this folder?"
+msgstr ""
+
#: src/components/ShareButton.tsx
msgid "Share"
msgstr ""
@@ -5259,11 +5264,6 @@ msgstr ""
msgid "Split list item"
msgstr ""
-#. Primary button — begins scaffolding the project
-#: src/components/ConsentDialogBody.tsx
-msgid "Start"
-msgstr ""
-
#: src/components/NavigatorApp.tsx
msgid "Start a new Open Knowledge project."
msgstr ""