Skip to content

Beautiful, AI-native markdown IDE and LLM wiki

some docs changes (#3530)

robert-inkeep970d73cdc112
diff --git a/docs/content/get-started/overview.mdx b/docs/content/get-started/overview.mdx
index eb6bf9c1f..e1a06cbd3 100644
--- a/docs/content/get-started/overview.mdx
+++ b/docs/content/get-started/overview.mdx
@@ -13,18 +13,16 @@ Available as a [desktop app](https://openknowledge.ai/download) for macOS, Windo
## Three layers
-OpenKnowledge is three layers working together: a "WYSIWYG" editor for you, MCP and skills for agents, and markdown files underneath.
+OpenKnowledge is three layers working together: a WYSIWYG editor for you, MCP and skills for agents, and your markdown files underneath.
<LayerStack />
## Additional Features
-- "Ask AI" experience for opening your knowledge base in your favorite agent
-- No-code **team sharing** and **Auto-sync** powered by git/GitHub under the hood.
-- **Remote access** to your knowledge base from your other devices and agents, over any tunnel. See [Remote access](/docs/deploy/remote-access).
-- A **built-in TUI** in the desktop app for Claude, Codex, OpenCode, and Cursor (macOS today)
-- Graph and wiki link visualizations
-- **Embeddable HTML** for writing engineering specs and visualized reports.
-- **Meeting ingestion** from Granola, Fireflies, and other recorders. On demand in any editor, or automatically on a schedule, from your agent's built-in scheduler or the [OpenClaw](../integrations/openclaw.mdx) gateway. See [Ingest meetings](../workflows/meeting-ingestion.mdx).
+- **[Ask AI](../features/editor.mdx#ask-ai)** experience and a built-in **[TUI](../features/editor.mdx#terminal)** for editing your knowledge base with your favorite agent.
+- Annotate your knowledge base with **[comments](../features/comments.mdx)**, then resolve them with AI.
+- **[Auto-sync](../features/github-sync.mdx)** knowledge base changes with your team using Git.
+- Explore your knowledge base through **[graph and wiki-link visualizations](../reference/core-concepts.md#links-and-backlinks)**.
+- [Connect to OpenKnowledge](../deploy/connecting-agents.mdx) remotely from local agents, remote agents, or other devices.
## Where to start
diff --git a/docs/content/get-started/quickstart.mdx b/docs/content/get-started/quickstart.mdx
index 4296b792b..03087ea27 100644
--- a/docs/content/get-started/quickstart.mdx
+++ b/docs/content/get-started/quickstart.mdx
@@ -1,37 +1,27 @@
---
title: Quickstart
icon: LuZap
-description: Set up your agent-maintained knowledge base in less than five minutes.
+description: Set up a knowledge base with OpenKnowledge in less than five minutes.
---
<Tabs groupId="ok-install" persist className="ok-flush-tabs" items={['Desktop app', 'Web app']}>
<Tab>
-<Callout type="info" title="Prerequisites">
- - **macOS** on Apple Silicon (M1 or later), **Windows 10+** (x64 or Arm64), or **Linux** (a Debian/Ubuntu or Fedora/RHEL family distro, x64 or arm64).
- - **`git`.** OpenKnowledge initializes a git repo for your project (used for the timeline and recovery features). macOS includes it with the Xcode Command Line Tools; on Windows or Linux, install it from [git-scm.com](https://git-scm.com) or your package manager.
-</Callout>
-
<Steps>
<Step>
### Install the desktop app
-Download the latest version of the OpenKnowledge desktop app for your platform. The button picks your platform automatically; use its dropdown for a different architecture or package format.
-
<DownloadButton />
-**macOS** — open the DMG and drag **OpenKnowledge** to **Applications**. (Apple Silicon only; on an Intel Mac, use the [web app](#ok-install-web-app).)
-
-**Windows** — download the installer for [x64](https://github.com/inkeep/open-knowledge/releases/latest/download/OpenKnowledge-Setup-x64.exe) or [Arm64](https://github.com/inkeep/open-knowledge/releases/latest/download/OpenKnowledge-Setup-arm64.exe) and run it. It installs per-user — no admin prompt — and adds OpenKnowledge to your Start menu.
-
-**Linux** — download the package for your distro family and architecture ([.deb x64](https://github.com/inkeep/open-knowledge/releases/latest/download/OpenKnowledge-amd64.deb), [.deb arm64](https://github.com/inkeep/open-knowledge/releases/latest/download/OpenKnowledge-arm64.deb), [.rpm x64](https://github.com/inkeep/open-knowledge/releases/latest/download/OpenKnowledge-x86_64.rpm), [.rpm arm64](https://github.com/inkeep/open-knowledge/releases/latest/download/OpenKnowledge-aarch64.rpm)), then install it:
-
-```bash
-sudo apt install ./OpenKnowledge-amd64.deb # Debian/Ubuntu
-sudo dnf install ./OpenKnowledge-x86_64.rpm # Fedora/RHEL
-```
+<Callout type="info" title="Verify Git is installed">
+ Open a terminal and run:
+ ```bash
+ git --version
+ ```
+ OpenKnowledge uses Git for timeline and recovery. If Git isn't installed, you can follow the instructions at [git-scm.com](https://git-scm.com/install/).
+</Callout>
</Step>
@@ -115,11 +105,11 @@ Right-click anywhere in the sidebar (empty space, a folder, or a file) to create
<Tab>
-The same editor, served locally and opened in your browser — for any platform the desktop app doesn't cover (an Intel Mac, a server) or when you just prefer the terminal.
+The same editor, served locally and accessible in your browser — for any platform the desktop app doesn't cover (an Intel Mac, a server) or when you just prefer the terminal.
<Callout type="info" title="Prerequisites">
- **Node.js 24+.** OpenKnowledge requires Node.js 24 or higher. Download from [nodejs.org](https://nodejs.org/en/download/).
- - **`git`.** OpenKnowledge initializes a git repo for your project (used for the timeline and recovery features). Install it from [git-scm.com](https://git-scm.com) or your package manager.
+ - **`git`.** OpenKnowledge uses Git for timeline and recovery. Install it from [git-scm.com](https://git-scm.com/install/).
</Callout>
<Steps>
diff --git a/docs/src/components/overview-blocks.tsx b/docs/src/components/overview-blocks.tsx
index 1cfb57a80..7bbca11f9 100644
--- a/docs/src/components/overview-blocks.tsx
+++ b/docs/src/components/overview-blocks.tsx
@@ -1,4 +1,4 @@
-import { ArrowRight, Bot, Database, type LucideIcon, NotebookPen } from 'lucide-react';
+import { ArrowRight, Bot, FileText, type LucideIcon, NotebookPen } from 'lucide-react';
import type { ReactNode } from 'react';
/**
@@ -24,28 +24,23 @@ const LAYERS: Layer[] = [
{
k: 'LAYER 01',
Icon: NotebookPen,
- title: 'Editor',
- role: 'What you touch',
- desc: (
- <>
- A beautiful "what you see is what you get" editor for your markdown files. Supports
- interactive HTML and JS, Mermaid diagrams, LaTeX, Videos, PDFs, and more.
- </>
- ),
+ title: 'WYSIWYG Editor',
+ role: 'Your Interface',
+ desc: 'A beautiful "what you see is what you get" editor for your markdown files. Supports interactive HTML and JS, Mermaid diagrams, LaTeX, Videos, PDFs, and more.',
},
{
k: 'LAYER 02',
Icon: Bot,
- title: 'Agent tools',
- role: 'Knowledge graph',
- desc: 'MCP and skills that improve agent search and discovery, and help agents ingest, organize, and maintain knowledge.',
+ title: 'MCP and Skills',
+ role: 'Agent toolkit',
+ desc: 'Tools for agents to help search, edit, expand, organize, and maintain your knowledge base.',
},
{
k: 'LAYER 03',
- Icon: Database,
- title: 'Content',
- role: 'Your source of truth',
- desc: 'Plain markdown or mdx files in your project, version-controlled in git.',
+ Icon: FileText,
+ title: 'Markdown Content',
+ role: 'Source of truth',
+ desc: 'Your knowledge base stays as plain markdown or mdx files in your project, version-controlled in git.',
},
];