Roadmap

GitHub & Bitbucket

Connect repos from both providers. Webhooks registered automatically on connect.

AI docs on every push

Every commit triggers documentation generation for changed files only.

Bring your own API key

Groq, Gemini, Anthropic, OpenAI, Mistral. Switch anytime, zero lock-in.

Smart regeneration

Skip pushes that only change whitespace, comments, or imports. No AI cost.

Semantic regeneration

A lightweight model checks whether the diff actually affects the docs before triggering a full update.

Exclusion list

Define glob patterns to skip folders, file types, or generated code.

Pause / resume repos

Stop doc updates during rapid releases, resume when you're ready.

Export as Markdown ZIP

Download all documentation as .md files, ready for Docusaurus, VitePress, or MkDocs.

Edit docs in the browser

Fix or extend any doc directly in the UI. No commits needed.

Job queue with live view

See processing status in real time. Retry, stop, or clear jobs individually.

Pretty formatting

One-click normalization of AI output: headings, bullets, spacing. Without touching the content.

GitLab

Same integration model as Bitbucket: OAuth token + webhook HMAC.

File chunking (413)

Split files that exceed a model's context window and merge the results.

Multi-provider AI

Configure multiple API keys simultaneously and route by repo or file type.

Provider fallback

Automatically switch to a backup provider when the primary hits a rate limit or daily cap.

Ollama

Fully local, zero-cost, zero-privacy-concern generation. Run any open model on your own hardware.

Public API

Call Readmify programmatically: pass your AI provider, API key, file content or repo reference, and get documentation back. Useful for CI pipelines, custom agents, and third-party integrations.