Features

Everything your team
needs to ship docs fast

Six core features that cover the full documentation lifecycle — from first commit to published API reference.

📄

README Generator

Instantly produce a professional README.md from any codebase — including project overview, installation steps, environment variables, usage examples, and badges. Never write a README from scratch again.

  • ✓Auto-detects project type (library, API, CLI, web app)
  • ✓Generates badges (version, license, CI status)
  • ✓Includes code examples pulled from your own code
docai — readme generator
# MyProject [![version](https://img.shields.io/badge/v2.1.0-lime)] ## Installation ```bash npm install myproject ``` ## Usage ```js import { create } from 'myproject'; create({ name: 'hello' }); ```
🔍

API Reference

Document every function, class, and method with parameter types, return values, and real usage examples. Output is structured Markdown that you can drop directly into your docs site.

  • ✓Auto-detects TypeScript types, Python hints, PHPDoc
  • ✓Generates working code examples for each function
  • ✓Exports as Markdown, HTML, or plain text
docai — api reference
## createUser(data) Creates a new user record. **Parameters** - `data.name` string — Full name - `data.email` string — Email address - `data.role` 'admin'|'user' **Returns** Promise<User> ```ts const user = await createUser({ name: 'Bhupinder', email: 'b@beveez.tech', role: 'admin' }); ```
💬

Inline Comments

Returns your code annotated with JSDoc, docstrings, or language-native comment format — with every function, parameter, and complex logic block explained in plain English.

  • ✓Respects existing comments — adds to, doesn't replace
  • ✓Follows JSDoc, PHPDoc, PyDoc, GoDoc conventions
  • ✓Works on files up to 2,000 lines
docai — inline comments
/** * Calculates the discounted price. * * @param {number} price - Original price in INR * @param {string} tier - User tier: 'solo'|'team' * @returns {number} Final price after discount */ function applyDiscount(price, tier) { const rates = { solo: 0.1, team: 0.25 }; return price * (1 - (rates[tier] ?? 0)); }
⚙️

GitHub Action

Add a single YAML file to your repo and DocAI will auto-generate documentation for every changed file on every pull request — committing the docs back as a separate commit.

  • ✓Setup takes under 5 minutes
  • ✓Works on any GitHub repository
  • ✓PRs get a comment with the docs preview link
docai — github action
# .github/workflows/docs.yml name: DocAI on: pull_request: paths: ['**.ts','**.py','**.php'] jobs: generate: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - name: Generate docs uses: beveez/docai-action@v1 with: api_key: ${{ secrets.DOCAI_KEY }}
🌐

20+ Languages

Full support for every major language — with language-specific conventions, comment formats, and type annotation styles respected in every generated doc.

  • ✓TypeScript, JavaScript, Python, PHP, Go, Rust, Java
  • ✓C++, C#, Ruby, Swift, Kotlin, Bash, SQL, HTML, CSS
  • ✓R, Scala, Elixir support in beta
docai — 20+ languages
// TypeScript ✓ function add(a: number, b: number): number # Python ✓ def add(a: int, b: int) -> int: <?php // PHP ✓ function add(int $a, int $b): int // Go ✓ func Add(a, b int) int // Rust ✓ pub fn add(a: i32, b: i32) -> i32
⬇️

Flexible Export

Copy to clipboard, download as .md, or use the API to push docs directly to your repo, Confluence, Notion, or any other documentation platform.

  • ✓One-click Markdown download
  • ✓REST API for CI/CD pipeline integration
  • ✓Notion and Confluence export coming Q3 2026
docai — flexible export
# Export options ## 1. Download curl -O docs.beveez.tech/export/readme.md ## 2. API curl -X POST /api/generate-public \ -H "Authorization: Bearer dak_..." ## 3. GitHub commit ✓ Committed to docs/generated/ on branch: feature/auth-module

Ready to try it?

Free tier — 5 docs per month. No credit card required.

Start generating for free →