Developers

Documentation

Welcome to the Devora documentation. This guide covers everything from your first repository import to advanced features.

Getting started

  1. Sign in with your GitHub account.
  2. Import a repository — Devora fetches your GitHub repos and lets you pick which ones to index.
  3. Wait for indexing — Devora reads the file tree and prepares your repository for documentation generation and chat.
  4. Generate documentation — Open the Documentation tab and Devora's AI generates 9 documentation pages from your source code.
  5. Chat with your codebase — Ask questions in plain English and get answers grounded in your actual source code.

Importing a repository

  1. Go to the Repositories tab in your dashboard.
  2. Click Import repository.
  3. Select the repository you want to import from your GitHub account.
  4. Choose which documentation types you want to generate (all 9 are selected by default).
  5. Click Import — Devora will index the repository in seconds.

Supported languages

Devora supports 60+ programming languages including TypeScript, JavaScript, Python, Go, Rust, Java, C/C++, C#, Ruby, PHP, Swift, Kotlin, and more. Frameworks are detected automatically from dependency manifests.

Private repositories

Devora supports both public and private GitHub repositories. Your GitHub access is used to read the repository's file tree and source files on demand — your source code is never permanently stored.

AI chat

The chat feature lets you ask questions about your codebase in plain English. The AI has context about your repository — its name, language, framework, and structure — and provides answers with source citations.

Documentation generation

Devora generates 9 types of documentation for each repository:

  1. README — Project overview, features, and quick start
  2. Architecture — System design with diagrams
  3. API Reference — Endpoints detected from source code
  4. Installation Guide — Setup and configuration steps
  5. Developer Guide — Local development, testing, and conventions
  6. Deployment Guide — Build, deploy, and health checks
  7. Environment Variables — All env vars detected from code
  8. Contributing Guide — Fork, branch, and PR process
  9. Changelog — Release history format

Regenerating documentation

Documentation is stored for 7 days. Click Regenerate on the Documentation tab to generate fresh documentation at any time. The AI reads the latest source code from your repository and produces updated content.

Exporting documentation

You can export your documentation as a Markdown file. The export includes all generated pages in a single .md file ready to drop into your repository.

Account settings

Theme

Choose between light, dark, or system theme. Your preference is saved per device.

Language

The dashboard UI is available in 8 languages: English, Chinese, Spanish, French, German, Japanese, Portuguese, and Russian.

Need help?

Email xfoundationcom@gmail.com — we reply within a day.