Pushpen generates README files, API documentation, changelogs, and onboarding guides from your actual source code. Every doc is generated from what your code actually does — and stays updated with every push.
Most documentation generators produce a one-time snapshot. Pushpen is different: it runs continuously against your repository, detecting changes and producing targeted updates. Your README reflects your current API. Your changelog captures every release. Your onboarding guide matches your actual setup process. Documentation stops being an artifact and starts being a live artifact of your codebase.
Start freeThe problem
Most teams generate documentation once at release and it immediately starts decaying. A week of commits later, the docs no longer match the code.
Unlike technical debt in code, documentation debt has no compiler warnings. It accumulates until a new hire spends three days debugging against outdated setup instructions.
How it works
Pushpen connects to your GitHub repository, analyzes your codebase, and generates documentation across the full surface of your project.
Install the Pushpen GitHub app with one click. Read-only access to your repository and pull requests.
Scans your file structure, package manifests, entry points, route definitions, and existing documentation.
AI produces README, API docs, changelog, and onboarding content based on your actual code and structure.
Pushpen detects changes, generates targeted updates, and opens PRs. Your docs never go stale.
What you get
Auto-generated README with project description, install instructions, usage examples, and API overview. Updates when your project changes.
Endpoint listings, request/response schemas, authentication requirements, and error codes extracted from route definitions.
Human-readable changelog following Keep a Changelog format, generated from your commit history and organized by release.
Setup guides, environment configuration, and quick-start instructions that match your actual project dependencies.
FAQ
Pushpen generates README files, API documentation, changelogs, release notes, onboarding guides, developer contribution docs, and inline docstring suggestions. It covers the full documentation surface of a software project.
Yes. Pushpen supports Python, JavaScript, TypeScript, Go, Rust, Ruby, Java, and many more. It automatically detects your project structure and adapts the generated documentation to your language and framework conventions.
Pushpen runs on every push to your repository. It compares what changed against the existing documentation and generates targeted updates. Instead of rewriting everything, it produces incremental PRs that reflect only what changed.
Yes. Pushpen works with both public and private GitHub repositories. Code is read-only and never stored or used for model training.
Static site generators require you to write and maintain Markdown files manually. Pushpen generates the content for you from your actual code and keeps it synchronized. You can still use Docusaurus or GitBook to render the output — Pushpen handles the content creation and maintenance.