Skip to content

Beautiful, AI-native markdown IDE and LLM wiki

a docs pass (#3547)

robert-inkeepb6a5b72e683f
diff --git a/docs/.gitignore b/docs/.gitignore
index 87da530ab..2344cdbab 100644
--- a/docs/.gitignore
+++ b/docs/.gitignore
@@ -7,3 +7,4 @@
.env.docker
.env.production
.env.staging
+next-env.d.ts
diff --git a/docs/content/integrations/antigravity.mdx b/docs/content/integrations/antigravity.mdx
index 29ab53991..82c1a6ca0 100644
--- a/docs/content/integrations/antigravity.mdx
+++ b/docs/content/integrations/antigravity.mdx
@@ -1,10 +1,10 @@
---
title: Antigravity
-description: Use OpenKnowledge with Google Antigravity — the agentic IDE and the agy terminal agent — over MCP.
+description: Use OpenKnowledge with Antigravity.
icon: custom/Antigravity
---
-[Antigravity](https://antigravity.google) is Google's agentic development platform: an IDE and the `agy` terminal agent (the successor to the Gemini CLI). Both connect to MCP servers. Once OpenKnowledge is registered as one, Antigravity can read, search, and write your knowledge base through OK's tools — with full attribution, link-awareness, conflict-awareness, and a live browser preview. Inside an OK project, work markdown through those tools rather than native file access, so every edit stays attributed and previewable.
+[Antigravity](https://antigravity.google) is Google's agentic development platform: an IDE and the `agy` terminal agent.
## Install
diff --git a/docs/content/integrations/codex.mdx b/docs/content/integrations/codex.mdx
index fd0842af6..e0314f6d9 100644
--- a/docs/content/integrations/codex.mdx
+++ b/docs/content/integrations/codex.mdx
@@ -1,10 +1,10 @@
---
title: Codex
-description: Use OpenKnowledge with OpenAI Codex.
+description: Use OpenKnowledge with Codex.
icon: custom/Codex
---
-OpenKnowledge plugs into Codex through MCP.
+OpenKnowledge works with Codex through MCP plus an installed skill.
## Install
diff --git a/docs/content/integrations/cursor.mdx b/docs/content/integrations/cursor.mdx
index e6625073c..0c2c2ef9e 100644
--- a/docs/content/integrations/cursor.mdx
+++ b/docs/content/integrations/cursor.mdx
@@ -4,7 +4,7 @@ description: Use OpenKnowledge with Cursor.
icon: custom/Cursor
---
-OpenKnowledge plugs into Cursor through MCP plus an installed skill that teaches the agent how to use the tools.
+OpenKnowledge works with Cursor through MCP plus an installed skill.
## Install
diff --git a/docs/content/integrations/github-copilot-cli.mdx b/docs/content/integrations/github-copilot-cli.mdx
index 5ffe4780f..7e68f90cc 100644
--- a/docs/content/integrations/github-copilot-cli.mdx
+++ b/docs/content/integrations/github-copilot-cli.mdx
@@ -4,7 +4,7 @@ description: Use OpenKnowledge with GitHub Copilot CLI.
icon: custom/GitHub
---
-OpenKnowledge plugs into GitHub Copilot CLI through MCP.
+[GitHub Copilot CLI](https://github.com/features/copilot/cli) is a terminal-native AI coding assistant.
## Install
diff --git a/docs/content/integrations/hermes.mdx b/docs/content/integrations/hermes.mdx
index 5d4de0784..d5ef83daf 100644
--- a/docs/content/integrations/hermes.mdx
+++ b/docs/content/integrations/hermes.mdx
@@ -1,10 +1,10 @@
---
title: Hermes
-description: Use OpenKnowledge with Hermes Agent over MCP.
+description: Use OpenKnowledge with Hermes Agent.
icon: custom/Hermes
---
-[Hermes Agent](https://hermes-agent.nousresearch.com) (Nous Research) is a terminal coding agent that connects to MCP servers. Once OpenKnowledge is registered as one, Hermes can read, search, and write your knowledge base through OK's tools — with full attribution, link-awareness, conflict-awareness, and a live browser preview. Inside an OK project, work markdown through those tools rather than native file access, so every edit stays attributed and previewable.
+[Hermes Agent](https://hermes-agent.nousresearch.com) is an open-source, self-improving AI agent framework.
## Install
diff --git a/docs/content/integrations/lm-studio.mdx b/docs/content/integrations/lm-studio.mdx
index 591fe5204..b38b16a47 100644
--- a/docs/content/integrations/lm-studio.mdx
+++ b/docs/content/integrations/lm-studio.mdx
@@ -1,10 +1,10 @@
---
title: LM Studio
-description: Use OpenKnowledge with local models in LM Studio over MCP.
+description: Use OpenKnowledge with LM Studio.
icon: LuCpu
---
-[LM Studio](https://lmstudio.ai) is a desktop app for running open models locally. It's an [MCP](https://modelcontextprotocol.io) **host** — its chat connects to MCP servers — so once OpenKnowledge is registered, a locally-hosted model can read, search, and write your knowledge base through OK's tools, with full attribution, link-awareness, conflict-awareness, and a live browser preview. Nothing leaves your machine: both the model and the knowledge base run locally.
+[LM Studio](https://lmstudio.ai) is a desktop app for running open models locally on your machine.
## Install
diff --git a/docs/content/integrations/meta.json b/docs/content/integrations/meta.json
index 896c4363a..5a68475c5 100644
--- a/docs/content/integrations/meta.json
+++ b/docs/content/integrations/meta.json
@@ -3,14 +3,14 @@
"icon": "LuPlug",
"pages": [
"claude-code",
- "cursor",
"codex",
- "github-copilot-cli",
+ "cursor",
"opencode",
"pi",
"openclaw",
+ "hermes",
"antigravity",
- "lm-studio",
- "hermes"
+ "github-copilot-cli",
+ "lm-studio"
]
}
diff --git a/docs/content/integrations/openclaw.mdx b/docs/content/integrations/openclaw.mdx
index 6fcd7ff06..eb03e4d0b 100644
--- a/docs/content/integrations/openclaw.mdx
+++ b/docs/content/integrations/openclaw.mdx
@@ -1,10 +1,10 @@
---
title: OpenClaw
-description: Use OpenKnowledge with OpenClaw agents over MCP.
+description: Use OpenKnowledge with OpenClaw.
icon: custom/OpenClaw
---
-[OpenClaw](https://openclaw.ai) is an agent gateway: it runs agents that connect to MCP servers. Once OpenKnowledge is registered as one of them, every agent OpenClaw runs can read, search, and write your knowledge base through OK's tools — with full attribution, link-awareness, conflict-awareness, and a live browser preview. Inside an OK project, agents work markdown through those tools rather than native file access, so every edit stays attributed and previewable.
+[OpenClaw](https://openclaw.ai) is an open-source personal AI assistant framework.
**Auto-sync your meetings.** The gateway has a built-in scheduler and a webhook listener, so once OpenKnowledge is registered it can run tasks against your knowledge base unattended. The headline example is keeping meeting notes flowing in on their own. See [Ingest meetings](../workflows/meeting-ingestion.mdx) for the cron recipe and the recorder list. The webhook mechanics, for running an agent the moment a meeting event fires, are documented below.
diff --git a/docs/content/integrations/opencode.mdx b/docs/content/integrations/opencode.mdx
index f48e926ef..ae4606473 100644
--- a/docs/content/integrations/opencode.mdx
+++ b/docs/content/integrations/opencode.mdx
@@ -1,10 +1,10 @@
---
title: OpenCode
-description: Use OpenKnowledge with OpenCode — including fully local models via Ollama, LM Studio, or any OpenAI-compatible endpoint.
+description: Use OpenKnowledge with OpenCode.
icon: custom/OpenCode
---
-OpenKnowledge plugs into [OpenCode](https://opencode.ai) through MCP. OpenCode is a terminal-based coding agent that works with any model — cloud or fully local — so you can run an entirely local edit-your-knowledge-base loop.
+[OpenCode](https://opencode.ai) is an open-source AI coding agent.
## Install
diff --git a/docs/content/integrations/pi.mdx b/docs/content/integrations/pi.mdx
index cc1fa93f7..d38bbb8ec 100644
--- a/docs/content/integrations/pi.mdx
+++ b/docs/content/integrations/pi.mdx
@@ -1,10 +1,10 @@
---
title: Pi
-description: Use OpenKnowledge with Pi — a minimal, extensible terminal coding agent — via OpenKnowledge's managed bridge extension.
+description: Use OpenKnowledge with Pi.
icon: custom/Pi
---
-OpenKnowledge plugs into [Pi](https://pi.dev) through a managed **bridge extension**. Pi is a minimal terminal coding agent that deliberately ships without MCP support — its extension point is TypeScript extensions — so instead of an MCP config entry, OpenKnowledge drops a small extension into your project that connects Pi to your knowledge base.
+[Pi](https://pi.dev) is an open-source, minimal terminal coding harness. Instead of MCP, OpenKnowledge plugs into Pi through a bridge extension.
## Install
@@ -13,15 +13,15 @@ Run `ok init` in your project (or open the project in the OpenKnowledge desktop
- **`.pi/extensions/open-knowledge.ts`** — the bridge extension. On session start it launches OpenKnowledge's MCP server with the same resilient launcher every other editor uses, then registers each OpenKnowledge tool as a native Pi tool under an `ok_` prefix (`ok_exec`, `ok_search`, `ok_write`, …). The prefix keeps OpenKnowledge's `edit` / `write` from shadowing Pi's built-in file tools.
- **`.pi/skills/open-knowledge/`** — the OpenKnowledge skill, in the [Agent Skills](https://pi.dev/docs/latest) format Pi reads natively from `.pi/skills/`.
-Both files are OpenKnowledge-managed: `ok init` re-runs refresh them in place, and `ok deinit` removes them. Don't hand-edit the bridge — your changes are overwritten on the next sync.
+These files are managed by OpenKnowledge. Running `ok init` again refreshes them in place, while `ok deinit` removes them.
## Trust the project
-Pi loads project-local extensions and skills **only after you trust the folder**. The first time you run `pi` in the project (and on fresh clones), Pi shows a trust prompt — accept it, or OpenKnowledge's tools and skill won't load. Your decision is remembered in `~/.pi/agent/trust.json`. Context files like `AGENTS.md` load regardless of trust.
+Make sure Pi trusts the project folder. Pi does not load project-local extensions or skills from `.pi/` until the project is trusted. When you first run pi in the project, accept the trust prompt. See Pi's [project trust documentation](https://pi.dev/docs/latest/security#project-trust) for more details.
## Verify
-Run `pi` in the project, trust it if prompted, and ask:
+Run `pi` in the project, and ask:
<CopyPrompt>List the first 5 documents you come across in this project.</CopyPrompt>
diff --git a/docs/next-env.d.ts b/docs/next-env.d.ts
deleted file mode 100644
index 9edff1c7c..000000000
--- a/docs/next-env.d.ts
+++ /dev/null
@@ -1,6 +0,0 @@
-/// <reference types="next" />
-/// <reference types="next/image-types/global" />
-import "./.next/types/routes.d.ts";
-
-// NOTE: This file should not be edited
-// see https://nextjs.org/docs/app/api-reference/config/typescript for more information.