langfuse-docs

langfuse-docs

🪢 Langfuse documentation -- Langfuse is the open source LLM Engineering Platform. Observability, evals, prompt management, playground and metrics to debug and improve LLM apps

Stars: 139

Visit
 screenshot

Langfuse Docs is a repository for langfuse.com, built on Nextra. It provides guidelines for contributing to the documentation using GitHub Codespaces and local development setup. The repository includes Python cookbooks in Jupyter notebooks format, which are converted to markdown for rendering on the site. It also covers media management for images, videos, and gifs. The stack includes Nextra, Next.js, shadcn/ui, and Tailwind CSS. Additionally, there is a bundle analysis feature to analyze the production build bundle size using @next/bundle-analyzer.

README:

GitHub Banner

Langfuse Docs

Repo for langfuse.com. Based on Nextra.

GitHub Codespaces

You can easily contribute to the docs using GitHub Codespaces. Just click on the "Code" button and select "Open with Codespaces". This will open a new Codespace with all the dependencies installed and the development server running.

Local Development

Pre-requisites: Node.js 22, pnpm v9.5.0

  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. Ensure you have uv installed
  2. Run bash scripts/update_cookbook_docs.sh (uv will automatically handle dependencies)
  3. Commit the changed markdown files

Note: All .md files or .mdx files that contain "source: ⚠️ Jupyter Notebook" on top in the pages/ directory are automatically generated from Jupyter notebooks. Do not edit them manually as they will be overwritten. Always edit the Jupyter notebooks and run the conversion script.

Media

Images

We store all images in the public/images/ directory. To use them in the markdown files, use the absolute path /images/your-image.png.

Videos / Gifs

We use a bucket on Cloudflare R2 to store all video. It is hosted on https://static.langfuse.com/docs-videos. Ping one of the maintainers to upload a video to the bucket and get the src.

To embed a video, use the Video component and set a title and fixed aspect ratio. Point src to the mp4 file in the bucket.

To embed a "gif", actually embed a video and use gifMode (<Video src="" gifMode />). This will look like a gif, but at a much smaller file size and higher quality.

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.

For Tasks:

Click tags to check more tools for each tasks

For Jobs:

Alternative AI tools for langfuse-docs

Similar Open Source Tools

For similar tasks

For similar jobs