Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ jobs:
fail-fast: false
matrix:
python-version: ["3.11", "3.12"]
defaults:
run:
working-directory: ./py

steps:
- uses: actions/checkout@v4
Expand Down
1 change: 0 additions & 1 deletion .python-version

This file was deleted.

3 changes: 2 additions & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,9 @@ build:
create_environment:
- uv venv "${READTHEDOCS_VIRTUALENV_PATH}"
install:
- cd py
- UV_PROJECT_ENVIRONMENT="${READTHEDOCS_VIRTUALENV_PATH}" uv sync --frozen --group docs

# Build documentation with Mkdocs
mkdocs:
configuration: mkdocs.yml
configuration: py/mkdocs.yml
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

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

![Diagram](./docs/diagram.png)
![Diagram](/docs/diagram.png)

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.

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

![Demo Video](./docs/demo.gif)
![Demo Video](/docs/demo.gif)

Start by defining model classes that specify your streaming structure:

Expand Down Expand Up @@ -265,8 +265,8 @@ LangDiff enables you to build responsive, maintainable AI applications where the

## License

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

## Demo

See [`example.py`](./example.py) for a runnable end-to-end demo using streaming parsing and diff tracking.
See [`py/example.py`](/py/example.py) for a runnable end-to-end demo using streaming parsing and diff tracking.
File renamed without changes.
1 change: 1 addition & 0 deletions py/README.md
File renamed without changes.
File renamed without changes.
File renamed without changes.
Binary file added py/docs/diagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.