From 4c32fda62857f156180c09c7c90190c4dbce1c6d Mon Sep 17 00:00:00 2001 From: Johann Schopplich Date: Tue, 18 Nov 2025 22:50:54 +0100 Subject: [PATCH] docs: improve intro sentence --- README.md | 2 +- docs/.vitepress/theme/overrides.css | 18 ++++++++++++++++-- docs/guide/getting-started.md | 2 +- 3 files changed, 18 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 02f7639..16b6d2b 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ [![npm downloads (total)](https://img.shields.io/npm/dt/@toon-format/toon.svg)](https://www.npmjs.com/package/@toon-format/toon) [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE) -**Token-Oriented Object Notation** is a compact, human-readable encoding of the JSON data model for LLM prompts. It provides a lossless serialization of the same objects, arrays, and primitives as JSON, but in a syntax that minimizes tokens and makes structure easy for models to follow. +**Token-Oriented Object Notation** is a compact, human-readable encoding of the JSON data model that minimizes tokens and makes structure easy for models to follow. It's intended for *LLM input* as a lossless, drop-in representation of JSON data. TOON combines YAML's indentation-based structure for nested objects with a CSV-style tabular layout for uniform arrays. TOON's sweet spot is uniform arrays of objects (multiple fields per row, same structure across items), achieving CSV-like compactness while adding explicit structure that helps LLMs parse and validate data reliably. For deeply nested or non-uniform data, JSON may be more efficient. diff --git a/docs/.vitepress/theme/overrides.css b/docs/.vitepress/theme/overrides.css index b99a9af..1c37276 100644 --- a/docs/.vitepress/theme/overrides.css +++ b/docs/.vitepress/theme/overrides.css @@ -15,6 +15,20 @@ details summary { } .VPHomeHero .image-src { - max-width: 180px !important; - max-height: 180px !important; + max-width: 112px; + max-height: 112px; +} + +@media (min-width: 640px) { + .VPHomeHero .image-src { + max-width: 144px; + max-height: 144px; + } +} + +@media (min-width:960px) { + .VPHomeHero .image-src { + max-width: 176px; + max-height: 176px; + } } diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md index f51cc15..db872ea 100644 --- a/docs/guide/getting-started.md +++ b/docs/guide/getting-started.md @@ -2,7 +2,7 @@ ## What is TOON? -**Token-Oriented Object Notation** is a compact, human-readable encoding of the JSON data model for LLM prompts. It provides a lossless serialization of the same objects, arrays, and primitives as JSON, but in a syntax that minimizes tokens and makes structure easy for models to follow. +**Token-Oriented Object Notation** is a compact, human-readable encoding of the JSON data model that minimizes tokens and makes structure easy for models to follow. It's intended for *LLM input* as a lossless, drop-in representation of JSON data. TOON combines YAML's indentation-based structure for nested objects with a CSV-style tabular layout for uniform arrays. TOON's sweet spot is uniform arrays of objects (multiple fields per row, same structure across items), achieving CSV-like compactness while adding explicit structure that helps LLMs parse and validate data reliably.