GitHub Banner

Langfuse Docs

Repo for langfuse.com, based on Nextra

Local Development

Pre-requisites: Node.js 18+, pnpm

  1. Optional: Create env based on .env.template
  2. Run pnpm i to install the dependencies.
  3. Run pnpm dev to start the development server on localhost:3333

Python cookbooks

All Jupyter notebooks are in the cookbook/ directory. For JS/TS notebooks we use Deno, see Readme in cookbook folder for more details.

To render them within the documentation site, we convert them to markdown using jupyter nbconvert, move them to right path in the pages/ directory where they are rendered by Nextra (remark).

Steps after updating notebooks:

  1. Load python shell/env which has jupyter installed, e.g. poetry install && poetry shell
  2. Run bash scripts/update_cookbook_docs.sh
  3. Commit the changed markdown files

API Reference (Swagger)

API reference is automatically generated based on the OpenAPI spec of the current production deployment of Langfuse Cloud.

Stack

Interested in stack of Q&A docs chatbot? Checkout the blog post for implementation details (all open source)

Bundle analysis

Run pnpm run analyze to analyze the bundle size of the production build using @next/bundle-analyzer.