Beautiful, AI-native markdown IDE and LLM wiki
TypeScript 2nd-brainagent-skillsclaudecodexcompany-braindocsknowledge-knowledge-baseknowledge-managementllmllm-wikillm-wiki-karpathymarkdownmarkdown-editormdmdxnotespkmsecond-brainskills
docs: polish Open Knowledge get-started and integration pages (#1728)
Andrew Mikofalvyae8ef3d47c46
diff --git a/docs/content/features/ignore-patterns.mdx b/docs/content/features/ignore-patterns.mdxindex 7052b71d2..e09beb59f 100644--- a/docs/content/features/ignore-patterns.mdx+++ b/docs/content/features/ignore-patterns.mdx@@ -1,9 +1,9 @@---title: Ignore patterns-description: Hide files and folders from the editor, search, and your AI tools.+description: Hide files and folders from the editor, search, and your AI agents.----Open Knowledge indexes the markdown in your project so it can power the file tree, search, and the tools your AI agents call. When you don't want a file in that picture (drafts, scratch notes, vendor-pasted material), hide it with an ignore pattern. Hidden items don't appear in the file tree, don't show up in search, and don't reach AI tools through MCP. Nothing on disk is deleted.+Open Knowledge indexes the markdown in your project so it can power the file tree, search, and the tools your AI agents call. When you don't want a file in that picture (drafts, scratch notes, vendor-pasted material), hide it with an ignore pattern. Hidden items don't appear in the file tree, don't show up in search, and don't reach AI agents through MCP. Nothing on disk is deleted.## Hide a file from the file treediff --git a/docs/content/get-started/overview.mdx b/docs/content/get-started/overview.mdxindex 31c2df839..709dbb363 100644--- a/docs/content/get-started/overview.mdx+++ b/docs/content/get-started/overview.mdx@@ -1,6 +1,7 @@---title: Overview-description: A markdown knowledge base your AI coding tools can read and edit, plus a rich editor that opens automatically when they do.+description: A markdown knowledge base your AI coding agents can read and edit, plus a rich editor that opens automatically when they do.+footer: false---Open Knowledge is a native macOS app for creating and maintaining a portable markdown knowledge base alongside the agents you already use. It works with any MCP-capable agent.@@ -23,5 +24,3 @@ Open Knowledge is three layers working together: a surface you edit, an engine t## Where to start<WhereToStart />--<QuickstartCTA />diff --git a/docs/content/get-started/quickstart.mdx b/docs/content/get-started/quickstart.mdxindex 453472e3c..da019a3fe 100644--- a/docs/content/get-started/quickstart.mdx+++ b/docs/content/get-started/quickstart.mdx@@ -67,14 +67,14 @@ Starting from scratch? Build a brand-new, empty knowledge base.<Step>-### Open the project in your AI tool+### Open the project in your AI AgentWith Open Knowledge app open, click the **Open with AI** button and select your preferred agent from the list. This dispatches the current file, folder, or project to your chosen agent with a starter prompt.-+<Callout type="info">- If your tool prompts you to approve a new MCP server (Cursor does this), approve `open-knowledge`.+ If your agent prompts you to approve a new MCP server (Cursor does this), approve `open-knowledge`.</Callout></Step>diff --git a/docs/content/integrations/claude-code.mdx b/docs/content/integrations/claude-code.mdxindex 1776220a8..21750e75d 100644--- a/docs/content/integrations/claude-code.mdx+++ b/docs/content/integrations/claude-code.mdx@@ -1,23 +1,21 @@----title: Claude Code-description: Use Open Knowledge with Claude Code.+title: Claude Code CLI+description: Use Open Knowledge with the Claude Code CLI.---Open Knowledge works with Claude Code Agent via MCP and Skills.## Install-The Open Knowledge desktop app handles wiring. On first launch (or any time you open a project for the first time), the consent dialog detects Claude Code on your machine, lists it as one of the editors it can configure, and writes the MCP server entry plus the project skill for you.--It registers the MCP server in Claude Code's user config (`~/.claude.json`) and project config (`.mcp.json`), and installs a skill at `.claude/skills/open-knowledge/SKILL.md`. Re-trigger the dialog by deleting `~/.ok/mcp-status.json` and relaunching.+<McpInstall editor="Claude Code" />## VerifyOpen the project in Claude Code and ask:-> List all the docs in this project.+<VerifyExec subject="Claude Code" />-Claude Code should call `exec` (e.g. `ls`) and respond with your knowledge base. If Claude Code doesn't use the Open Knowledge `exec` tool, restart Claude Code so it picks up the new MCP entry.+If Claude Code doesn't use the Open Knowledge `exec` tool, restart Claude Code so it picks up the new MCP entry.## Live editingdiff --git a/docs/content/integrations/claude-desktop.mdx b/docs/content/integrations/claude-desktop.mdxindex 91e9100ea..0ef4a97c8 100644--- a/docs/content/integrations/claude-desktop.mdx+++ b/docs/content/integrations/claude-desktop.mdx@@ -1,18 +1,18 @@---title: Claude Desktop-description: Use Open Knowledge with the Claude Desktop app (Chat, Cowork, and the Code tab).+description: Use Open Knowledge with the Claude Desktop app (Chat, Cowork, and Code).---The Claude Desktop app has three modes that touch Open Knowledge differently.-- **Code tab** is Claude Code. Set it up via the [Claude Code](/docs/integrations/claude-code) page.-- **Chat** and **Cowork** read skills from a separate, isolated list. Use the install command below for those.+- **Code tab** is Claude Code. Set it up via the [Claude Code CLI](/docs/integrations/claude-code) page.+- **Chat** and **Cowork** read skills from a separate, isolated list. Use the steps below for those.## Installed from the macOS DMG-A consent dialog runs the first time the app launches. It detects every MCP-capable editor on your machine, preselects all of them, and writes user-level MCP entries when you click **Add** (or writes nothing when you click **Skip**). To re-trigger it, delete `~/.ok/mcp-status.json` and relaunch.+A consent dialog runs the first time the app launches. It detects your MCP-capable editors and wires them up when you click **Add**. To re-trigger it, delete `~/.ok/mcp-status.json` and relaunch.-The DMG path covers MCP wiring but doesn't install the skill that Chat and Cowork need. Run the command below for that.+This covers MCP wiring but not the skill that Chat and Cowork need — follow the steps below for that.## Install the skill (Chat + Cowork)@@ -22,20 +22,20 @@ The skill turns on automatically. Use it in any Chat or Cowork session.If `Customize → Skills` isn't visible, enable it in **Settings → Capabilities → Code execution and file creation**.+## Open with AI++Once the skill is installed, Chat and Cowork sessions can ask Open Knowledge for anything in the workspace through MCP. That's the user-facing surface. The editor's **Open with AI ▸** menu does not list Cowork as a target today (Cowork has no `claude-cowork://` deep-link scheme to dispatch to), so the menu surfaces Claude, Codex, and Cursor only. A claude.ai web fallback opens file-scope dispatches in the Claude web UI for users without a local Claude install; see [Editor → Open with AI](/docs/features/editor#open-with-ai) for the full menu UX.+## VerifyIn a fresh Chat or Cowork session:-> Use the open-knowledge skill to summarize what's in this workspace.+<CopyPrompt>List the first 5 documents you come across in this project.</CopyPrompt>Claude should recognize the skill and use Open Knowledge's tools.## Cowork: skill won't fire after install-<Callout type="info">-Upstream Cowork bugs, last verified May 2026. Drop this section once Anthropic ships a fix.-</Callout>-Claude Cowork has [an open bug](https://github.com/anthropics/claude-code/issues/26254) where custom skills register in the UI but don't mount in the session VM. Symptom: the skill shows enabled but Cowork tells you it isn't available.Workaround:@@ -48,7 +48,3 @@ Workaround:## Team and EnterpriseOrg owners can publish the skill once instead of asking every user to install it. Build the bundle from **Help → Install for Claude Chat & Cowork (Desktop App)…** in the Open Knowledge desktop app, then upload it via **Organization settings → Skills → + Add** in Claude Desktop. Every member sees it in Chat and Cowork.--## Open with AI--Once the skill is installed, Chat and Cowork sessions can ask Open Knowledge for anything in the workspace through MCP. That's the user-facing surface. The editor's **Open with AI ▸** menu does not list Cowork as a target today (Cowork has no `claude-cowork://` deep-link scheme to dispatch to), so the menu surfaces Claude, Codex, and Cursor only. A claude.ai web fallback opens file-scope dispatches in the Claude web UI for users without a local Claude install; see [Editor → Open with AI](/docs/features/editor#open-with-ai) for the full menu UX.diff --git a/docs/content/integrations/codex.mdx b/docs/content/integrations/codex.mdxindex abf22b16e..6be30ea51 100644--- a/docs/content/integrations/codex.mdx+++ b/docs/content/integrations/codex.mdx@@ -7,20 +7,18 @@ Open Knowledge plugs into Codex through MCP.## Install-The Open Knowledge desktop app handles wiring. On first launch (or any time you open a project for the first time), the consent dialog detects Codex on your machine, lists it as one of the editors it can configure, and writes the MCP server entry plus the project skill for you.+<McpInstall editor="Codex" />-It registers the MCP server in Codex's user config (`~/.codex/config.toml`) and project config (`.codex/config.toml`), and installs the Open Knowledge skill so Codex can call the MCP tools. Re-trigger the dialog by deleting `~/.ok/mcp-status.json` and relaunching.--## Verify+## Open with AI-Open the project in Codex and ask:+From the editor, **Open with AI ▸ Codex** dispatches the current file, folder, or project to Codex in one click. Three entry points: the editor header's sparkle icon, the sidebar's right-click menu (file / folder / empty space), and the macOS **File → Open with AI** menu.-> List all the docs in this project.+Codex receives a short prompt asking it to open the target in Open Knowledge's web preview. The agent then grounds the rest of the conversation through MCP. See [Editor → Open with AI](/docs/features/editor#open-with-ai) for the full UX.-The agent should call `exec` (e.g. `ls`) and respond with your knowledge base. If you don't see the tool, restart Codex.+## Verify-## Open with AI+Open the project in Codex and ask:-From the editor, **Open with AI ▸ Codex** dispatches the current file, folder, or project to Codex in one click. Three entry points: the editor header's sparkle icon, the sidebar's right-click menu (file / folder / empty space), and the macOS **File → Open with AI** menu.+<VerifyExec />-Codex receives a short prompt asking it to open the target in Open Knowledge's web preview. The agent then grounds the rest of the conversation through MCP. See [Editor → Open with AI](/docs/features/editor#open-with-ai) for the full UX.+If you don't see the tool, restart Codex.diff --git a/docs/content/integrations/cursor.mdx b/docs/content/integrations/cursor.mdxindex a4948224e..4fcf818de 100644--- a/docs/content/integrations/cursor.mdx+++ b/docs/content/integrations/cursor.mdx@@ -7,22 +7,12 @@ Open Knowledge plugs into Cursor through MCP plus an installed skill that teache## Install-The Open Knowledge desktop app handles wiring. On first launch (or any time you open a project for the first time), the consent dialog detects Cursor on your machine, lists it as one of the editors it can configure, and writes the MCP server entry plus the project skill for you.--It registers the MCP server in Cursor's user config (`~/.cursor/mcp.json`) and project config (`.cursor/mcp.json`), and installs a skill at `.cursor/skills/open-knowledge/SKILL.md`. Re-trigger the dialog by deleting `~/.ok/mcp-status.json` and relaunching.+<McpInstall editor="Cursor" />## Approve the serverCursor prompts you to approve a new MCP server when you next open the project. Approve `open-knowledge`. Until you do, the agent can't see the tools.-## Verify--Ask the agent:--> List all the docs in this project.--The agent should call `exec` (e.g. `ls`) and respond with your knowledge base. If it still doesn't see the tool after approval, restart Cursor so it picks up the new MCP entry.-## Open with AIFrom the editor, **Open with AI ▸ Cursor** dispatches the current file, folder, or project to Cursor. Three entry points: the editor header's sparkle icon, the sidebar's right-click menu (file / folder / empty space), and the macOS **File → Open with AI** menu.@@ -30,3 +20,11 @@ From the editor, **Open with AI ▸ Cursor** dispatches the current file, folderCursor uses a two-step handoff: Open Knowledge spawns `cursor <projectDir>` to open the workspace first, then fires the `cursor://` URL with a short prompt asking Cursor to open the target in Open Knowledge's web preview. The agent then grounds the rest of the conversation through MCP. See [Editor → Open with AI](/docs/features/editor#open-with-ai) for the full UX.Cursor's spawn step requires the local Electron app. The row is hidden in the web build, where there's no process-spawn API.++## Verify++Ask the agent:++<VerifyExec />++If it still doesn't see the tool after approval, restart Cursor so it picks up the new MCP entry.diff --git a/docs/content/integrations/meta.json b/docs/content/integrations/meta.jsonindex b51cf5b6a..c06fcedb8 100644--- a/docs/content/integrations/meta.json+++ b/docs/content/integrations/meta.json@@ -1,5 +1,5 @@{"title": "Integrations","icon": "LuPlug",- "pages": ["claude-code", "claude-desktop", "cursor", "codex"]+ "pages": ["claude-desktop", "claude-code", "cursor", "codex"]}diff --git a/docs/content/reference/mcp.mdx b/docs/content/reference/mcp.mdxindex acf257ea3..d0ef6be2f 100644--- a/docs/content/reference/mcp.mdx+++ b/docs/content/reference/mcp.mdx@@ -64,6 +64,6 @@ To detect conflict state proactively without waiting for a 409, call `conflicts(## Preview links-Read and write tools return a `previewUrl` for any doc they touched, but **those are route-only** (`/#/<doc>` with no host:port), meant to identify the doc, not to be opened as-is. Hosts that want to open the editor (Claude Code Desktop's `preview_start`, terminal `open <url>`) call `preview_url` to resolve the full URL once per session. The editor refocuses automatically on subsequent writes.+Read and write tools return a `previewUrl` for any doc they touched, but **those are route-only** (`/#/<doc>` with no host:port), meant to identify the doc, not to be opened as-is. Hosts that want to open the editor (Claude Code Desktop's `preview_start`, terminal `open <url>`) call `preview_url` to resolve the full URL once per session.`preview_url` always carries an `autoOpen` boolean (top-level on its response) reflecting the user's [`appearance.preview.autoOpen`](/docs/reference/configuration) preference. The write tools (`write`, `edit`) carry the same boolean on the `warning` object, which fires only when no browser is attached to the preview. In the common case (a browser is attached), the write response has no `warning` and no `autoOpen` field. Agents honor `autoOpen` before navigating: `true` (default) follows the host-capability routing in the bundled skill; `false` means the user is managing their own preview window, so the agent surfaces the URL on request but does not open or refresh anything. The value is resolved fresh on every tool call, so a mid-session toggle propagates within 0–1 calls, with no client restart.diff --git a/docs/content/workflows/karpathy-llm-wiki.mdx b/docs/content/workflows/karpathy-llm-wiki.mdxindex c66473559..10c9c7f09 100644--- a/docs/content/workflows/karpathy-llm-wiki.mdx+++ b/docs/content/workflows/karpathy-llm-wiki.mdx@@ -117,9 +117,7 @@ The starter-pack picker is idempotent (safe to re-run on the same project).If you accepted the desktop app's first-launch offer to wire up your agent assistant, you're done. If not, in your agent assistant ([Claude Code](../integrations/claude-code.mdx), [Cursor](../integrations/cursor.mdx), or [Codex](../integrations/codex.mdx)), ask:-```-> list the workflow tools available-```+<CopyPrompt>list the workflow tools available</CopyPrompt>You should see `mcp__open-knowledge__workflow` (its `kind` covers `ingest` / `research` / `consolidate` / `discover`), alongside the standard reads/writes (`exec`, `search`, `write`, `links`, etc.). The workflow guides cover the sources → provisional → canonical pipeline described in the mapping table above.@@ -127,33 +125,25 @@ You should see `mcp__open-knowledge__workflow` (its `kind` covers `ingest` / `reFor each source, paste the URL into your agent and say:-```-> ingest this: https://github.com/example/framework-```+<CopyPrompt>ingest this: https://github.com/example/framework</CopyPrompt>The agent fetches the URL, calls `ingest`, and writes the verbatim content to `external-sources/framework-readme.md` with frontmatter capturing the URL, fetch date, and any author metadata it can extract. **Never copy-paste raw URLs into chat as "sources" without ingesting.** The knowledge base is closed-loop. Every claim must cite a local doc.Five ingests, five files. After the fifth, ask:-```-> what's in external-sources/, summary of each-```+<CopyPrompt>what's in external-sources/, summary of each</CopyPrompt>Your agent uses `exec("ls external-sources/")` to read frontmatter and per-file summaries.### 5. Synthesize into a research log-```-> research the agent-framework question; synthesize the five sources in external-sources/-```+<CopyPrompt>research the agent-framework question; synthesize the five sources in external-sources/</CopyPrompt>Running `workflow({ kind: "research", topic: "agent-framework evaluation" })` spins up a step-by-step research flow: it confirms scoping, lists what's covered by the existing sources, identifies gaps (maybe one source you haven't ingested yet), and produces a `research/agent-framework-evaluation.md` with `status: provisional` and a `sources:` array listing the five paths.Every claim in the log cites a specific source path. You can now ask:-```-> what does the framework do when two sub-agents race on the same write?-```+<CopyPrompt>what does the framework do when two sub-agents race on the same write?</CopyPrompt>The agent reads `research/agent-framework-evaluation.md` first, follows the citation chain into `external-sources/`, and returns a synthesized answer with traceable evidence.@@ -171,9 +161,7 @@ Result: the agent learns each layer's discipline without a separate prompt or skYou don't consolidate yet in our scenario; the team hasn't decided. Maybe in two weeks you adopt the framework. Then:-```-> consolidate the agent-framework research into a canonical article-```+<CopyPrompt>consolidate the agent-framework research into a canonical article</CopyPrompt>The `workflow` tool's `consolidate` kind starts with a STOP gate asking whether the decision is actually made. If yes, it writes `articles/agent-framework-evaluation.md` with `status: canonical` and a `supersedes:` chain pointing back to the research log. That `research/` doc isn't deleted; it's superseded, so the evidence chain stays intact.diff --git a/docs/source.config.ts b/docs/source.config.tsindex c6ff7ff8a..263ea59a3 100644--- a/docs/source.config.ts+++ b/docs/source.config.ts@@ -14,6 +14,9 @@ export const docs = defineDocs({schema: frontmatterSchema.extend({sidebarTitle: z.string().optional(),keywords: z.string().optional(),+ // Set `footer: false` on hub/index pages to hide Fumadocs' prev/next+ // page navigation when the page already curates its own forward links.+ footer: z.boolean().optional(),}),},});diff --git a/docs/src/app/docs/[...slug]/page.tsx b/docs/src/app/docs/[...slug]/page.tsxindex 25cd8e898..53642c0d7 100644--- a/docs/src/app/docs/[...slug]/page.tsx+++ b/docs/src/app/docs/[...slug]/page.tsx@@ -10,9 +10,15 @@ export default async function Page(props: PageProps<'/docs/[...slug]'>) {if (!page) notFound();const MDX = page.data.body;+ const hideFooter = page.data.footer === false;return (- <DocsPage toc={page.data.toc} full={page.data.full}>+ <DocsPage+ toc={page.data.toc}+ full={page.data.full}+ footer={hideFooter ? { enabled: false } : undefined}+ article={hideFooter ? { className: 'pb-12' } : undefined}+ ><DocsTitle>{page.data.title}</DocsTitle><DocsDescription>{page.data.description}</DocsDescription><DocsBody>diff --git a/docs/src/components/copy-prompt.tsx b/docs/src/components/copy-prompt.tsxindex 881896adc..6a74157b0 100644--- a/docs/src/components/copy-prompt.tsx+++ b/docs/src/components/copy-prompt.tsx@@ -1,15 +1,25 @@'use client';import { Check, Copy } from 'lucide-react';-import { useState } from 'react';+import { isValidElement, type ReactNode, useState } from 'react';type CopyPromptProps = {- children: string;+ children: ReactNode;};+function flattenText(node: ReactNode): string {+ if (typeof node === 'string') return node;+ if (typeof node === 'number') return String(node);+ if (Array.isArray(node)) return node.map(flattenText).join('');+ if (isValidElement(node)) {+ return flattenText((node.props as { children?: ReactNode }).children);+ }+ return '';+}+export function CopyPrompt({ children }: CopyPromptProps) {const [copied, setCopied] = useState(false);- const text = children.trim();+ const text = flattenText(children).trim();const copy = async () => {try {@@ -27,7 +37,9 @@ export function CopyPrompt({ children }: CopyPromptProps) {data-copied={copied}className="ok-overview not-prose group my-2.5 flex w-full cursor-pointer items-start gap-3 rounded-lg border border-fd-border bg-fd-card px-4 py-3 text-start text-[0.9375rem] leading-relaxed text-fd-foreground shadow-sm transition hover:border-[var(--ok-accent)] hover:bg-fd-accent/40">- <span className="flex-1 whitespace-pre-wrap">{text}</span>+ {/* Quotes + italics are presentational — they signal "this is a prompt".+ The copied payload is `text`, without them. */}+ <span className="flex-1 whitespace-pre-wrap italic">“{text}”</span><spanclassName="mt-px inline-flex shrink-0 items-center gap-1.5 text-[12.5px] font-medium text-fd-muted-foreground transition-colors group-hover:text-[var(--ok-accent)]"style={copied ? { color: 'var(--ok-accent)' } : undefined}diff --git a/docs/src/components/icons/codex.tsx b/docs/src/components/icons/codex.tsxindex 7760be298..4d213766f 100644--- a/docs/src/components/icons/codex.tsx+++ b/docs/src/components/icons/codex.tsx@@ -6,18 +6,16 @@ export function CodexIcon(props: SVGProps<SVGSVGElement>) {role="img"aria-label="Codex icon"xmlns="http://www.w3.org/2000/svg"- width={32}- height={32}+ width={24}+ height={24}fill="none"- viewBox="0 0 32 32"+ viewBox="0 0 9 9"{...props}><title>Codex icon</title><path- stroke="currentColor"- strokeLinecap="round"- strokeWidth="2.484"- d="M22.356 19.797H17.17M9.662 12.29l1.979 3.576a.511.511 0 0 1-.005.504l-1.974 3.409M30.758 16c0 8.15-6.607 14.758-14.758 14.758-8.15 0-14.758-6.607-14.758-14.758C1.242 7.85 7.85 1.242 16 1.242c8.15 0 14.758 6.608 14.758 14.758Z"+ fill="currentColor"+ d="M3.03191 0.172167C3.39319 0.023523 3.7865 -0.030181 4.17441 0.0161665C4.67441 0.0736665 5.11991 0.286167 5.51091 0.653667C5.51591 0.658667 5.52291 0.662167 5.52941 0.664167C5.53647 0.665904 5.54385 0.665904 5.55091 0.664167C6.05923 0.532896 6.59731 0.581475 7.07391 0.801667L7.09741 0.812666L7.15541 0.841167C7.65429 1.09402 8.04342 1.52067 8.24941 2.04067C8.35391 2.29567 8.40591 2.56117 8.40691 2.83817C8.41442 3.04417 8.39185 3.25017 8.33991 3.44967C8.33735 3.45974 8.33738 3.47029 8.34 3.48035C8.34263 3.4904 8.34775 3.49963 8.35491 3.50717C8.65191 3.81067 8.84891 4.17217 8.94641 4.59217C9.09091 5.30467 8.94291 5.94717 8.50291 6.51917L8.43491 6.60217C8.14349 6.93574 7.761 7.17695 7.33441 7.29617C7.32515 7.29888 7.31666 7.30373 7.30962 7.31033C7.30259 7.31694 7.2972 7.3251 7.29391 7.33417C7.19841 7.60967 7.10241 7.84567 6.92391 8.08117C6.47391 8.67467 5.81291 9.00417 5.06841 9.00017C4.47491 8.99717 3.94891 8.78017 3.48991 8.34917C3.483 8.3427 3.4745 8.33819 3.46528 8.33608C3.45606 8.33397 3.44644 8.33435 3.43741 8.33717C3.24341 8.39967 3.04741 8.40867 2.83541 8.40617C2.49774 8.40346 2.16514 8.32377 1.86291 8.17317C1.54632 8.01629 1.27069 7.78773 1.05791 7.50567C0.981908 7.40467 0.906408 7.30967 0.850908 7.19717C0.775141 7.04279 0.713231 6.88199 0.665908 6.71667C0.566008 6.34048 0.563599 5.94504 0.658908 5.56767C0.662042 5.55869 0.663069 5.54911 0.661908 5.53967C0.660196 5.53039 0.655446 5.52195 0.648408 5.51567C0.417442 5.28189 0.240911 5.00002 0.131408 4.69017C0.0585831 4.49931 0.0162322 4.29818 0.00590778 4.09417C-0.0122568 3.82546 0.0115281 3.55556 0.0764078 3.29417C0.244908 2.73817 0.567408 2.30167 1.04291 1.98517C1.14891 1.91467 1.24941 1.85967 1.34341 1.82017C1.45091 1.77567 1.55841 1.73817 1.66641 1.70667C1.67413 1.70427 1.68113 1.70001 1.6868 1.69425C1.69247 1.68849 1.69663 1.68142 1.69891 1.67367C1.78091 1.37919 1.92194 1.10446 2.11341 0.866166C2.35477 0.559671 2.67114 0.320634 3.03191 0.172167ZM4.77291 5.45467C4.69165 5.45922 4.61522 5.49471 4.55931 5.55385C4.5034 5.61299 4.47225 5.69128 4.47225 5.77267C4.47225 5.85405 4.5034 5.93235 4.55931 5.99148C4.61522 6.05062 4.69165 6.08611 4.77291 6.09067H6.59091C6.63417 6.09309 6.67747 6.08667 6.71816 6.07178C6.75885 6.0569 6.79608 6.03387 6.82756 6.0041C6.85905 5.97433 6.88413 5.93846 6.90127 5.89866C6.91841 5.85887 6.92725 5.81599 6.92725 5.77267C6.92725 5.72934 6.91841 5.68647 6.90127 5.64667C6.88413 5.60688 6.85905 5.571 6.82756 5.54123C6.79608 5.51146 6.75885 5.48843 6.71816 5.47355C6.67747 5.45866 6.63417 5.45224 6.59091 5.45467H4.77291ZM2.73091 3.11517C2.68764 3.04469 2.61865 2.99381 2.53854 2.97328C2.45844 2.95275 2.37348 2.96419 2.30165 3.00517C2.22982 3.04615 2.17675 3.11346 2.15366 3.19287C2.13056 3.27228 2.13926 3.35756 2.17791 3.43067L2.81391 4.54267L2.18091 5.61067C2.1596 5.64662 2.14558 5.68641 2.13966 5.72778C2.13373 5.76914 2.13601 5.81127 2.14636 5.85176C2.15671 5.89225 2.17494 5.9303 2.2 5.96374C2.22506 5.99718 2.25646 6.02536 2.29241 6.04667C2.32836 6.06797 2.36815 6.08199 2.40952 6.08792C2.45088 6.09385 2.49301 6.09157 2.5335 6.08121C2.57399 6.07086 2.61204 6.05263 2.64548 6.02758C2.67892 6.00252 2.7071 5.97112 2.72841 5.93517L3.45541 4.70767C3.48407 4.65931 3.4994 4.60422 3.49984 4.548C3.50028 4.49179 3.48581 4.43647 3.45791 4.38767L2.73091 3.11517Z"/></svg>);diff --git a/docs/src/components/mcp-install.tsx b/docs/src/components/mcp-install.tsxnew file mode 100644index 000000000..2be9f5cc0--- /dev/null+++ b/docs/src/components/mcp-install.tsx@@ -0,0 +1,16 @@+import type { ReactNode } from 'react';++export function McpInstall({ editor, children }: { editor: string; children?: ReactNode }) {+ return (+ <>+ <p>+ The Open Knowledge desktop app handles this for you. The first time you open a project, a+ consent dialog detects {editor} and configures it.+ </p>+ {children}+ <p>+ To re-trigger the dialog, delete <code>~/.ok/mcp-status.json</code> and relaunch.+ </p>+ </>+ );+}diff --git a/docs/src/components/overview-blocks.tsx b/docs/src/components/overview-blocks.tsxindex 16820cb7a..d6bdda370 100644--- a/docs/src/components/overview-blocks.tsx+++ b/docs/src/components/overview-blocks.tsx@@ -126,26 +126,3 @@ export function WhereToStart() {</div>);}--export function QuickstartCTA() {- return (- <div className="ok-overview not-prose mt-10 flex flex-col items-start justify-between gap-5 rounded-2xl border border-fd-border bg-fd-card px-[26px] py-6 shadow-sm sm:flex-row sm:items-center sm:gap-6">- <div>- <span className="block text-base font-semibold text-fd-foreground">Quickstart</span>- <span className="text-sm text-fd-muted-foreground">- From install to your first agent-driven edit in under five minutes.- </span>- </div>- <a- href="/docs/get-started/quickstart"- className="inline-flex shrink-0 items-center gap-2 rounded-[10px] px-[18px] py-[11px] text-[14.5px] font-semibold text-white no-underline"- style={{- background: 'var(--ok-accent)',- boxShadow: '0 2px 8px color-mix(in oklch, var(--ok-accent) 40%, transparent)',- }}- >- Get started <ArrowRight className="size-[15px]" aria-hidden="true" />- </a>- </div>- );-}diff --git a/docs/src/components/verify-exec.tsx b/docs/src/components/verify-exec.tsxnew file mode 100644index 000000000..f266a1ea8--- /dev/null+++ b/docs/src/components/verify-exec.tsx@@ -0,0 +1,13 @@+import { CopyPrompt } from '@/components/copy-prompt';++export function VerifyExec({ subject = 'The agent' }: { subject?: string }) {+ return (+ <>+ <CopyPrompt>List the first 5 documents you come across in this project.</CopyPrompt>+ <p>+ {subject} should call the Open Knowledge <code>exec</code> tool and respond with some of+ your documents.+ </p>+ </>+ );+}diff --git a/docs/src/mdx-components.tsx b/docs/src/mdx-components.tsxindex 3803cf5c5..e13847db4 100644--- a/docs/src/mdx-components.tsx+++ b/docs/src/mdx-components.tsx@@ -10,8 +10,10 @@ import { AgentIcons } from '@/components/agent-icons';import { CopyPrompt } from '@/components/copy-prompt';import { CtaButton } from '@/components/cta-button';import { DownloadButton } from '@/components/download-button';+import { McpInstall } from '@/components/mcp-install';import { Mermaid } from '@/components/mermaid';-import { LayerStack, QuickstartCTA, WhereToStart } from '@/components/overview-blocks';+import { LayerStack, WhereToStart } from '@/components/overview-blocks';+import { VerifyExec } from '@/components/verify-exec';export function getMDXComponents(): MDXComponents {return {@@ -26,13 +28,14 @@ export function getMDXComponents(): MDXComponents {DownloadButton,Image: ImageZoom,LayerStack,+ McpInstall,Mermaid,- QuickstartCTA,Step,Steps,WhereToStart,Tab,Tabs,TypeTable,+ VerifyExec,};}diff --git a/packages/app/src/components/icons/codex.tsx b/packages/app/src/components/icons/codex.tsxindex 45bca6223..66210c280 100644--- a/packages/app/src/components/icons/codex.tsx+++ b/packages/app/src/components/icons/codex.tsx@@ -6,18 +6,16 @@ export function CodexIcon(props: SVGProps<SVGSVGElement>) {role="img"aria-label="Codex icon"xmlns="http://www.w3.org/2000/svg"- width={32}- height={32}+ width={24}+ height={24}fill="none"- viewBox="0 0 32 32"+ viewBox="0 0 9 9"{...props}><title>Codex icon</title><path- stroke="currentColor"- strokeLinecap="round"- strokeWidth="2.484"- d="M22.356 19.797H17.17M9.662 12.29l1.979 3.576a.511.511 0 0 1-.005.504l-1.974 3.409M30.758 16c0 8.15-6.607 14.758-14.758 14.758-8.15 0-14.758-6.607-14.758-14.758C1.242 7.85 7.85 1.242 16 1.242c8.15 0 14.758 6.608 14.758 14.758Z"+ fill="currentColor"+ d="M3.03191 0.172167C3.39319 0.023523 3.7865 -0.030181 4.17441 0.0161665C4.67441 0.0736665 5.11991 0.286167 5.51091 0.653667C5.51591 0.658667 5.52291 0.662167 5.52941 0.664167C5.53647 0.665904 5.54385 0.665904 5.55091 0.664167C6.05923 0.532896 6.59731 0.581475 7.07391 0.801667L7.09741 0.812666L7.15541 0.841167C7.65429 1.09402 8.04342 1.52067 8.24941 2.04067C8.35391 2.29567 8.40591 2.56117 8.40691 2.83817C8.41442 3.04417 8.39185 3.25017 8.33991 3.44967C8.33735 3.45974 8.33738 3.47029 8.34 3.48035C8.34263 3.4904 8.34775 3.49963 8.35491 3.50717C8.65191 3.81067 8.84891 4.17217 8.94641 4.59217C9.09091 5.30467 8.94291 5.94717 8.50291 6.51917L8.43491 6.60217C8.14349 6.93574 7.761 7.17695 7.33441 7.29617C7.32515 7.29888 7.31666 7.30373 7.30962 7.31033C7.30259 7.31694 7.2972 7.3251 7.29391 7.33417C7.19841 7.60967 7.10241 7.84567 6.92391 8.08117C6.47391 8.67467 5.81291 9.00417 5.06841 9.00017C4.47491 8.99717 3.94891 8.78017 3.48991 8.34917C3.483 8.3427 3.4745 8.33819 3.46528 8.33608C3.45606 8.33397 3.44644 8.33435 3.43741 8.33717C3.24341 8.39967 3.04741 8.40867 2.83541 8.40617C2.49774 8.40346 2.16514 8.32377 1.86291 8.17317C1.54632 8.01629 1.27069 7.78773 1.05791 7.50567C0.981908 7.40467 0.906408 7.30967 0.850908 7.19717C0.775141 7.04279 0.713231 6.88199 0.665908 6.71667C0.566008 6.34048 0.563599 5.94504 0.658908 5.56767C0.662042 5.55869 0.663069 5.54911 0.661908 5.53967C0.660196 5.53039 0.655446 5.52195 0.648408 5.51567C0.417442 5.28189 0.240911 5.00002 0.131408 4.69017C0.0585831 4.49931 0.0162322 4.29818 0.00590778 4.09417C-0.0122568 3.82546 0.0115281 3.55556 0.0764078 3.29417C0.244908 2.73817 0.567408 2.30167 1.04291 1.98517C1.14891 1.91467 1.24941 1.85967 1.34341 1.82017C1.45091 1.77567 1.55841 1.73817 1.66641 1.70667C1.67413 1.70427 1.68113 1.70001 1.6868 1.69425C1.69247 1.68849 1.69663 1.68142 1.69891 1.67367C1.78091 1.37919 1.92194 1.10446 2.11341 0.866166C2.35477 0.559671 2.67114 0.320634 3.03191 0.172167ZM4.77291 5.45467C4.69165 5.45922 4.61522 5.49471 4.55931 5.55385C4.5034 5.61299 4.47225 5.69128 4.47225 5.77267C4.47225 5.85405 4.5034 5.93235 4.55931 5.99148C4.61522 6.05062 4.69165 6.08611 4.77291 6.09067H6.59091C6.63417 6.09309 6.67747 6.08667 6.71816 6.07178C6.75885 6.0569 6.79608 6.03387 6.82756 6.0041C6.85905 5.97433 6.88413 5.93846 6.90127 5.89866C6.91841 5.85887 6.92725 5.81599 6.92725 5.77267C6.92725 5.72934 6.91841 5.68647 6.90127 5.64667C6.88413 5.60688 6.85905 5.571 6.82756 5.54123C6.79608 5.51146 6.75885 5.48843 6.71816 5.47355C6.67747 5.45866 6.63417 5.45224 6.59091 5.45467H4.77291ZM2.73091 3.11517C2.68764 3.04469 2.61865 2.99381 2.53854 2.97328C2.45844 2.95275 2.37348 2.96419 2.30165 3.00517C2.22982 3.04615 2.17675 3.11346 2.15366 3.19287C2.13056 3.27228 2.13926 3.35756 2.17791 3.43067L2.81391 4.54267L2.18091 5.61067C2.1596 5.64662 2.14558 5.68641 2.13966 5.72778C2.13373 5.76914 2.13601 5.81127 2.14636 5.85176C2.15671 5.89225 2.17494 5.9303 2.2 5.96374C2.22506 5.99718 2.25646 6.02536 2.29241 6.04667C2.32836 6.06797 2.36815 6.08199 2.40952 6.08792C2.45088 6.09385 2.49301 6.09157 2.5335 6.08121C2.57399 6.07086 2.61204 6.05263 2.64548 6.02758C2.67892 6.00252 2.7071 5.97112 2.72841 5.93517L3.45541 4.70767C3.48407 4.65931 3.4994 4.60422 3.49984 4.548C3.50028 4.49179 3.48581 4.43647 3.45791 4.38767L2.73091 3.11517Z"/></svg>);