From 2f6aad16543acd27cfd1f9ea28b02d65c8776a21 Mon Sep 17 00:00:00 2001 From: Nick Gomez <122398915+nick-inkeep@users.noreply.github.com> Date: Sat, 27 Jun 2026 03:22:16 -0700 Subject: [PATCH] docs: README + docs overview copy edits (with spelling fixes) (#2219) Ship pending README, docs overview page, and overview-blocks edits. Fix two spelling/typo errors: "WYSWIG" -> "WYSIWYG" in overview.mdx, and a missing space ("get"editor" -> "get" editor") in overview-blocks.tsx. GitOrigin-RevId: f5d3a79223c069ab56370fdb288ad8b0fd8a541e --- README.md | 8 ++++---- docs/content/get-started/overview.mdx | 20 +++++++++++--------- docs/src/components/overview-blocks.tsx | 23 +++++++++++------------ 3 files changed, 26 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 0aa2e648..5065a313 100644 --- a/README.md +++ b/README.md @@ -6,16 +6,16 @@
-OpenKnowledge is a beautiful markdown IDE with a WYSIWYG editor and integrations with Claude, Codex, and other harnesses. For knowledge bases, LLM wikis, specs, and notes. Private, local, and free. +OpenKnowledge is a beautiful markdown editor with integrations with Claude, Codex, and other harnesses. For knowledge bases, LLM wikis, specs, and notes. Private, local, and free.
.md files: WYSIWYG or source mode, backlinks, the{' '}
- [[Page]] wiki-link syntax, frontmatter, asset embeds, and version history, with
- a live preview as agents work.
+ 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: 'Knowledge Engine',
- role: 'The connective layer',
- desc: 'Thin MCP wrappers around system functions. Agents read and write through them, so every change automatically carries frontmatter, backlinks, and edit history.',
+ title: 'Agent tools',
+ role: 'Knowledge graph',
+ desc: 'MCP and skills that improve agent search and discovery, and help agents ingest, organize, and maintain knowledge.',
},
{
k: 'LAYER 03',
Icon: Database,
title: 'Content',
role: 'Your source of truth',
- desc: 'Plain markdown files in your project, version-controlled in git. No new database, no migration; your knowledge stays portable.',
+ desc: 'Plain markdown or mdx files in your project, version-controlled in git.',
},
];
@@ -82,18 +81,18 @@ interface Path {
const PATHS: Path[] = [
{
href: '/docs/get-started/quickstart',
- title: 'New to OpenKnowledge? Run the Quickstart',
+ title: 'Try the Quickstart',
desc: 'Install the desktop app and get your first agent-driven edit in under five minutes.',
},
{
href: '/docs/integrations/claude-code',
title: 'Setting up an editor?',
- desc: 'Pick yours from Integrations: Claude, Cursor, Codex, or OpenCode.',
+ desc: 'Use with Claude, Cursor, Codex, or OpenCode.',
},
{
- href: '/docs/reference/mcp',
- title: 'Looking up a tool or config field?',
- desc: 'Head to the MCP and Configuration reference.',
+ href: '/docs/workflows/karpathy-llm-wiki',
+ title: 'Set up an LLM Wiki',
+ desc: 'Build a Karpathy-style LLM Wiki',
},
];