Skip to content

tectijuana/davia

 
 

Repository files navigation

Davia Banner

What is Davia?

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.

Excalidraw Example


Quick Start

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

This is the Davia workspace view of your generated docs:

Design Agent Example


Contributing

Contributions are welcome! We'd love your help to make Davia better:

  • Report bugs or request features — Open an issue to let us know what's not working or what you'd like to see
  • Improve the codebase — Submit pull requests with bug fixes, new features, or optimizations
  • Share feedback — Tell us what you think and help shape Davia's future

Example

davia-docs-excalidraw_compressed.mp4

Another example with flows:

davia-docs-demo-github.mp4

License

This project is licensed under the MIT License - see the LICENSE file for details.

About

Documentation that writes itself

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 93.8%
  • CSS 3.3%
  • JavaScript 2.9%