Skip to content

Commit 9ab3c03

Browse files
adds descriptions to all pages
1 parent 3f31091 commit 9ab3c03

30 files changed

Lines changed: 177 additions & 0 deletions

packages/docs/docs/guide/async/async-components.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
description:
3+
Use async function components, understand promise propagation, and know when JSX results
4+
must be awaited.
5+
---
6+
17
# Async Components
28

39
A Kita Html component can be an `async` function. When it is, the JSX expression evaluates

packages/docs/docs/guide/async/error-boundaries.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
description:
3+
Catch errors from async components with ErrorBoundary, handle fallback failures, and
4+
combine boundaries with Suspense.
5+
---
6+
17
# Error Boundaries
28

39
Error boundaries catch errors thrown by async components and render a fallback instead of

packages/docs/docs/guide/async/streaming-internals.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
description:
3+
Understand the HTML, template, script, and chunked transfer protocol behind Suspense
4+
streaming.
5+
---
6+
17
# Streaming Internals
28

39
This page describes how Suspense streaming works at the protocol level, from the initial

packages/docs/docs/guide/async/suspense.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
description:
3+
Conceptual guide to Suspense streaming, request isolation, and when progressive async
4+
rendering is worth using.
5+
---
6+
17
# Suspense Streaming
28

39
Without Suspense, the server must wait for every async component to resolve before sending

packages/docs/docs/guide/async/using-suspense.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
description:
3+
Wrap async sections with Suspense, stream fallbacks, handle errors, share request IDs,
4+
and avoid async fallback delays.
5+
---
6+
17
# Using Suspense
28

39
Import `Suspense` and `renderToStream` from `@kitajs/html/suspense`.

packages/docs/docs/guide/getting-started.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
description:
3+
Install Kita Html, configure TypeScript, enable the XSS plugin, and verify the scanner
4+
catches unsafe JSX.
5+
---
6+
17
import { PackageManagerTabs } from '@rspress/core/theme'
28

39
# Getting Started

packages/docs/docs/guide/how-jsx-becomes-html.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
description:
3+
Follow the compile-time JSX rewrite and the runtime steps that turn props and children
4+
into HTML strings.
5+
---
6+
17
# How JSX Becomes HTML
28

39
The transformation from JSX to an HTML string happens in two stages: a compile-time

packages/docs/docs/guide/introduction.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
description:
3+
Overview of Kita Html's string-based JSX runtime, XSS protection model, async
4+
components, and package structure.
5+
---
6+
17
import { Tab, Tabs } from '@rspress/core/theme'
28

39
# What is Kita Html

packages/docs/docs/guide/jsx/design-decisions.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
description:
3+
Architectural rationale for omitting context and for defining JSX.Element as string or
4+
Promise<string>.
5+
---
6+
17
# Design Decisions
28

39
This page documents the major architectural decisions in Kita Html and their rationale.

packages/docs/docs/guide/jsx/extending-types.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
description:
3+
Extend JSX.IntrinsicElements and HtmlTag to support custom elements, custom attributes,
4+
or unrestricted tags.
5+
---
6+
17
# Extending JSX Types
28

39
Kita Html's type system can be extended to support custom elements, custom attributes, or

0 commit comments

Comments
 (0)