From 35865dc8862f18599579d582a0e88883dcc71dc1 Mon Sep 17 00:00:00 2001 From: Sebastian Herrlinger Date: Sat, 21 Feb 2026 17:38:48 +0100 Subject: [PATCH] docs update --- README.md | 6 ++---- packages/core/README.md | 3 +-- packages/core/docs/getting-started.md | 2 +- packages/core/package.json | 2 +- packages/web/src/content/docs/getting-started.mdx | 2 +- packages/web/src/layouts/Base.astro | 2 +- packages/web/src/layouts/Docs.astro | 2 +- packages/web/src/pages/index.astro | 8 ++++---- 8 files changed, 12 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index f43e30a60..5488782e1 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,7 @@ awesome opentui list -OpenTUI is a TypeScript library for building terminal user interfaces (TUIs). It is currently in -development and is not ready for production use. It will be the foundational TUI framework for both -[OpenCode](https://opencode.ai) and [terminaldotshop](https://terminal.shop). +OpenTUI is a native terminal UI core written in Zig with TypeScript bindings. The native core exposes a C ABI and can be used from any language. OpenTUI powers [OpenCode](https://opencode.ai) in production today and will also power [terminal.shop](https://terminal.shop). It is an extensible core with a focus on correctness, stability, and high performance. It provides a component-based architecture with flexible layout capabilities, allowing you to create complex terminal applications. Docs: https://opentui.com/docs/getting-started @@ -20,7 +18,7 @@ bun create tui This monorepo contains the following packages: -- [`@opentui/core`](packages/core) - The core library works completely standalone, providing an imperative API and all the primitives. +- [`@opentui/core`](packages/core) - TypeScript bindings for OpenTUI's native Zig core, with an imperative API and all primitives. - [`@opentui/solid`](packages/solid) - The SolidJS reconciler for OpenTUI. - [`@opentui/react`](packages/react) - The React reconciler for OpenTUI. diff --git a/packages/core/README.md b/packages/core/README.md index 80590fe19..35fffd6d8 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -1,7 +1,6 @@ # OpenTUI Core -OpenTUI Core is a TypeScript library for building terminal user interfaces (TUIs). It is currently in -development and is not ready for production use. +OpenTUI is a native terminal UI core written in Zig with TypeScript bindings. The native core exposes a C ABI and can be used from any language. OpenTUI powers OpenCode in production today and will also power terminal.shop. It is an extensible core with a focus on correctness, stability, and high performance. It provides a component-based architecture with flexible layout capabilities, allowing you to create complex terminal applications. ## Documentation diff --git a/packages/core/docs/getting-started.md b/packages/core/docs/getting-started.md index 4405312c3..db16f7f51 100644 --- a/packages/core/docs/getting-started.md +++ b/packages/core/docs/getting-started.md @@ -1,6 +1,6 @@ # Getting Started with OpenTUI -OpenTUI is a TypeScript library for building terminal user interfaces (TUIs). It provides a component-based architecture with flexible layout capabilities, allowing you to create complex console applications. +OpenTUI is a native terminal UI core written in Zig with TypeScript bindings. The native core exposes a C ABI and can be used from any language. OpenTUI powers OpenCode in production today and will also power terminal.shop. It is an extensible core with a focus on correctness, stability, and high performance. It provides a component-based architecture with flexible layout capabilities, allowing you to create complex terminal applications. ## Core Concepts diff --git a/packages/core/package.json b/packages/core/package.json index 28af18ddb..64d98a10b 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -1,6 +1,6 @@ { "name": "@opentui/core", - "description": "OpenTUI is a TypeScript library for building terminal user interfaces (TUIs)", + "description": "OpenTUI is a TypeScript library on a native Zig core for building terminal user interfaces (TUIs)", "repository": { "type": "git", "url": "https://github.com/anomalyco/opentui", diff --git a/packages/web/src/content/docs/getting-started.mdx b/packages/web/src/content/docs/getting-started.mdx index 5caec85f6..d80d36908 100644 --- a/packages/web/src/content/docs/getting-started.mdx +++ b/packages/web/src/content/docs/getting-started.mdx @@ -6,7 +6,7 @@ order: 1 # Getting started -OpenTUI is a TypeScript library for building terminal user interfaces. +OpenTUI is a native terminal UI core written in Zig with TypeScript bindings. The native core exposes a C ABI and can be used from any language. OpenTUI powers OpenCode in production today and will also power terminal.shop. It is an extensible core with a focus on correctness, stability, and high performance. It provides a component-based architecture with flexible layout capabilities, allowing you to create complex terminal applications. ## Installation diff --git a/packages/web/src/layouts/Base.astro b/packages/web/src/layouts/Base.astro index c345130bd..2f2a54058 100644 --- a/packages/web/src/layouts/Base.astro +++ b/packages/web/src/layouts/Base.astro @@ -6,7 +6,7 @@ interface Props { const { title, - description = "TypeScript library for building terminal user interfaces" + description = "OpenTUI is a TypeScript library on a native Zig core for building terminal user interfaces (TUIs)" } = Astro.props --- diff --git a/packages/web/src/layouts/Docs.astro b/packages/web/src/layouts/Docs.astro index aa647826f..409148412 100644 --- a/packages/web/src/layouts/Docs.astro +++ b/packages/web/src/layouts/Docs.astro @@ -119,7 +119,7 @@ const isActive = (path: string) => currentPath === path || currentPath === `${pa diff --git a/packages/web/src/pages/index.astro b/packages/web/src/pages/index.astro index 0d4cf29c2..d8baf89fd 100644 --- a/packages/web/src/pages/index.astro +++ b/packages/web/src/pages/index.astro @@ -42,7 +42,7 @@ const features = [ ] --- - +
@@ -87,9 +87,9 @@ const features = [
-

Terminal UIs in TypeScript

+

Terminal UIs on a Native Zig Core

- Build rich, interactive terminal interfaces with flexbox layouts and first-class TypeScript support. + Build rich, interactive terminal interfaces with TypeScript bindings, first-class React/Solid support, and a C ABI for any language.

@@ -229,7 +229,7 @@ renderer.root.add(

What is OpenTUI?

-

OpenTUI is a TypeScript library for building rich, interactive terminal user interfaces.

+

OpenTUI is a native terminal UI core written in Zig with TypeScript bindings. The native core exposes a C ABI and can be used from any language. OpenTUI powers OpenCode in production today and will also power terminal.shop. It is an extensible core with a focus on correctness, stability, and high performance. It provides a component-based architecture with flexible layout capabilities, allowing you to create complex terminal applications.