Skip to content

Beautiful, AI-native markdown IDE and LLM wiki

docs(open-knowledge): example knowledge base CTA + refreshed quickstart (#1695)

Andrew Mikofalvy8622b683a8f4
diff --git a/docs/content/get-started/quickstart.mdx b/docs/content/get-started/quickstart.mdx
index b6bfa9ba4..4698371fc 100644
--- a/docs/content/get-started/quickstart.mdx
+++ b/docs/content/get-started/quickstart.mdx
@@ -26,7 +26,13 @@ _Apple Silicon (M1 and later) only for now; Intel Macs are not yet supported._
### Pick a project
-Click **Pick Existing Project** to choose one, or click **Create New Project** to scaffold a fresh one. You can also **Clone from GitHub** to pull down a remote repo.
+**Want to explore without any setup?** Open our example knowledge base — a collection of notes on notable tech IPOs — and poke around:
+
+<CtaButton href="https://openknowledge.ai/d/AWh0dHBzOi8vZ2l0aHViLmNvbS9pbmtlZXAvdGVjaC1pcG9zL2Jsb2IvbWFpbi9SRUFETUUubWQ" label="Open the example knowledge base" />
+
+This opens a shared doc in your browser; click **Open in Open Knowledge** to open it in the app.
+
+Otherwise, click **Pick Existing Project** to choose one, **Create New Project** to scaffold a fresh one, or **Clone from GitHub** to pull down a remote repo.
The first-launch consent dialog detects every MCP-capable editor on your machine (Claude Code, Cursor, Codex, Claude Desktop) and offers to wire them up to Open Knowledge.
@@ -36,7 +42,7 @@ The first-launch consent dialog detects every MCP-capable editor on your machine
### Open the project in your AI tool
-Click the <OpenWithAiButton /> button and select your preferred tool. This dispatches the current file, folder, or project to your chosen agent with a starter prompt.
+Click the **Open with AI** button and select your preferred tool. This dispatches the current file, folder, or project to your chosen agent with a starter prompt.
If your tool prompts you to approve a new MCP server (Cursor does this), approve `open-knowledge`.
@@ -48,17 +54,17 @@ If your tool prompts you to approve a new MCP server (Cursor does this), approve
Opening a project initializes the Open Knowledge MCP tools for that project. From then on, your agent prefers Open Knowledge's tool wrappers over its built-in file operations, so its edits keep your front matter consistent and your links intact.
-Try one of these:
+If you opened the example knowledge base, try one of these:
-> Add a new note explaining how this project handles authentication.
+> Update the SpaceX note with the latest news about its IPO.
-> Search for any docs that mention OAuth.
+> Search for any docs that mention valuation.
> List the recent docs.
-Or something structural:
+Or something that spans the whole knowledge base:
-> Set up a `specs/` folder and gather all my specifications into it. Give them consistent front matter so I can query them easily.
+> Update the historical IPO prices across these notes to account for inflation.
</Step>
diff --git a/docs/src/components/cta-button.tsx b/docs/src/components/cta-button.tsx
new file mode 100644
index 000000000..336f82a5b
--- /dev/null
+++ b/docs/src/components/cta-button.tsx
@@ -0,0 +1,25 @@
+import { ArrowRight } from 'lucide-react';
+import Image from 'next/image';
+
+type CtaButtonProps = {
+ href: string;
+ label: string;
+ external?: boolean;
+};
+
+export function CtaButton({ href, label, external = true }: CtaButtonProps) {
+ return (
+ <a
+ href={href}
+ {...(external ? { target: '_blank', rel: 'noopener noreferrer' } : {})}
+ className="ok-overview not-prose group my-4 inline-flex items-center gap-2.5 rounded-[10px] border border-fd-border bg-fd-card py-2.5 pr-4 pl-3.5 text-[14.5px] font-semibold text-fd-foreground no-underline shadow-sm transition hover:-translate-y-px hover:border-[var(--ok-accent)]"
+ >
+ <Image src="/ok-logo.png" alt="" width={40} height={40} className="size-5 shrink-0" />
+ {label}
+ <ArrowRight
+ className="size-4 shrink-0 text-[var(--ok-accent)] transition-transform group-hover:translate-x-0.5"
+ aria-hidden="true"
+ />
+ </a>
+ );
+}
diff --git a/docs/src/components/open-with-ai-button.tsx b/docs/src/components/open-with-ai-button.tsx
deleted file mode 100644
index 419b15b56..000000000
--- a/docs/src/components/open-with-ai-button.tsx
+++ /dev/null
@@ -1,11 +0,0 @@
-import { ChevronRight, Sparkles } from 'lucide-react';
-
-export function OpenWithAiButton() {
- return (
- <span className="not-prose mx-0.5 inline-flex select-none items-center gap-1.5 rounded-md border border-fd-border bg-fd-muted px-2 py-0.5 align-middle text-sm font-medium text-fd-foreground">
- <Sparkles className="size-3.5 text-fd-muted-foreground" aria-hidden="true" />
- Open with AI
- <ChevronRight className="size-3 text-fd-muted-foreground" aria-hidden="true" />
- </span>
- );
-}
diff --git a/docs/src/mdx-components.tsx b/docs/src/mdx-components.tsx
index 7706f8927..20e15474b 100644
--- a/docs/src/mdx-components.tsx
+++ b/docs/src/mdx-components.tsx
@@ -7,9 +7,9 @@ import { TypeTable } from 'fumadocs-ui/components/type-table';
import defaultMdxComponents from 'fumadocs-ui/mdx';
import type { MDXComponents } from 'mdx/types';
import { AgentIcons } from '@/components/agent-icons';
+import { CtaButton } from '@/components/cta-button';
import { DownloadButton } from '@/components/download-button';
import { Mermaid } from '@/components/mermaid';
-import { OpenWithAiButton } from '@/components/open-with-ai-button';
import { LayerStack, QuickstartCTA, WhereToStart } from '@/components/overview-blocks';
export function getMDXComponents(): MDXComponents {
@@ -20,11 +20,11 @@ export function getMDXComponents(): MDXComponents {
AgentIcons,
Card,
Cards,
+ CtaButton,
DownloadButton,
Image: ImageZoom,
LayerStack,
Mermaid,
- OpenWithAiButton,
QuickstartCTA,
Step,
Steps,