Skip to content

Commit c68957d

Browse files
committed
docs: update TypeScript documentation to be language-specific
- Convert Python-focused docs/index.md to TypeScript examples - Remove demo files (cast and gif) that may not be relevant to TypeScript implementation - Update code examples from Python decorators to TypeScript method calls - Change installation instructions from pip/uv to npm/yarn - Update API references to match TypeScript naming conventions
1 parent 74f3768 commit c68957d

File tree

5 files changed

+70
-257
lines changed

5 files changed

+70
-257
lines changed

ts/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
LangDiff is a TypeScript library that solves the hard problems of streaming structured LLM outputs to frontends.
88

9-
![Diagram](./docs/diagram.png)
9+
![Diagram](/ts/docs/diagram.png)
1010

1111
LangDiff provides intelligent partial parsing with granular, type-safe events as JSON structures build token by token, plus automatic JSON Patch generation for efficient frontend synchronization. Build responsive AI applications where your backend structures and frontend experiences can evolve independently. Read more about it on the [Motivation](#motivation) section.
1212

@@ -110,7 +110,7 @@ Suppose you want to generate a multi-section article with an LLM. Rather than wa
110110
you can stream the article progressively by first generating section titles as they're determined,
111111
then streaming each section's content as it's written.
112112

113-
![Demo Video](./docs/demo.gif)
113+
![Demo Video](/docs/demo.gif)
114114

115115
Start by defining model classes that specify your streaming structure:
116116

@@ -292,7 +292,7 @@ LangDiff enables you to build responsive, maintainable AI applications where the
292292

293293
## License
294294

295-
Apache-2.0. See the [LICENSE](./LICENSE) file for details.
295+
Apache-2.0. See the [LICENSE](/LICENSE) file for details.
296296

297297
## Examples
298298

@@ -352,4 +352,4 @@ npx ts-node examples/01-basic-streaming.ts
352352
npx ts-node examples/05-article-generation.ts
353353
```
354354

355-
See the [`examples/`](./examples/) directory for detailed implementations and the [`examples/README.md`](./examples/README.md) for comprehensive documentation.
355+
See the [`examples/`](/ts/examples/) directory for detailed implementations and the [`examples/README.md`](/ts/examples/README.md) for comprehensive documentation.

0 commit comments

Comments
 (0)