Open sourced an editable wiki with whiteboards for your codebase

Today, we're excited to announce that we've released an open source version of Davia. You can clone it, run it locally, and generate interactive documentation for your codebase: complete with editable whiteboards and visualizations.

What is Davia's open source package?

Davia is an open-source tool that generates interactive internal documentation for your local codebase. Point it at a project path and it writes documentation files locally with interactive visualizations and editable whiteboards that you can edit in a Notion-like platform or locally in your IDE.

The best part? Everything happens in real-time. You can watch your documentation populate, edit pages as they appear, and create custom visualizations on the fly.

Quick Start

Getting started with Davia takes just a few minutes:

1. Clone and Install

git clone https://github.com/davialabs/davia.git
cd davia
pnpm i

2. Configuration

By default, Davia looks for a .env file in the root of the project path you provide. Configuration is only optional if there are already API keys in the project path you're generating docs from. To configure API keys in the Davia monorepo instead:

1. Rename .env.example to .env
2. Add your AI provider API key (we recommend Anthropic for best results)
3. Davia will use the first available key in this order: Anthropic → OpenAI → Google

3. Run Docs

pnpm run docs

The process involves two steps:

1. Enter the absolute path when prompted:

   Enter absolute path of the project to document: /path/to/project

2. Provide a prompt describing what to document (e.g., "Document the authentication system" or "Create API documentation").

Davia spins up a docs window that populates in real time, and you can edit the pages as they appear.

4. View Results (Optional)

If you stopped the process and want to view the results later, you can launch the visualization app manually:

pnpm run open

See it in action

Here's Davia generating interactive documentation with editable whiteboards for a codebase:

⭐ Star us on GitHub

If you find Davia useful, give us a star on GitHub. It helps others discover the project and motivates us to keep building in the open.