Summary

Davia is an open-source tool designed to automate the creation of interactive internal documentation for local codebases. It addresses the challenge of maintaining up-to-date and accessible project documentation by generating files with interactive visualizations that can be edited directly within a Notion-like platform or a local IDE. This benefits developers and teams by streamlining the documentation process and providing a dynamic, easily updatable knowledge base.

How It Works

Davia operates by analyzing a specified local project path. It leverages AI providers, prioritizing Anthropic, then OpenAI, and finally Google, using their respective API keys for content generation. The tool writes documentation files locally, incorporating interactive visualizations that populate in real-time. Users can then edit these generated pages directly within a dedicated workspace interface, akin to Notion, or within their integrated development environment, facilitating a fluid documentation workflow.

Quick Start & Requirements

To get started, clone the repository (git clone https://github.com/davialabs/davia.git), navigate into the directory (cd davia), and install dependencies using pnpm i. Configuration involves setting up an .env file with an AI provider API key (Anthropic is recommended for optimal results). To generate documentation, run pnpm run docs and provide the absolute path to your project. An optional command, pnpm run open, can launch the visualization app to view results later.

Highlighted Details

• Generates interactive, editable documentation files with visualizations.
• Features a real-time updating workspace view, similar to Notion.
• Allows direct editing of documentation pages within the workspace or IDE.
• Supports multiple AI providers for documentation generation: Anthropic, OpenAI, and Google.

Maintenance & Community

Contributions are welcomed through bug reports and feature requests via GitHub Issues, and code improvements via Pull Requests. Users are encouraged to share feedback to help shape the project's future. Specific community channels like Discord or Slack are not detailed in the provided information.

Licensing & Compatibility

This project is licensed under the MIT License, which is generally permissive for commercial use and integration into closed-source projects.

Limitations & Caveats

The provided information does not detail specific limitations, known bugs, or alpha/beta status. Users should verify compatibility with their specific project structures and AI provider access.