# Pushpen

> Pushpen watches a GitHub repository and automatically generates documentation updates (README, CHANGELOG, API reference, onboarding guide) whenever code is pushed, delivered as a pull request by default. It reasons from the actual diff and a persistent, structured fact sheet of the repository (dependencies, license, routes, declared AI provider), not general knowledge, and runs a scheduled fact-check pass against existing docs.

## Product

- [Homepage](https://pushpen.dev/): what Pushpen does, how it works, pricing.
- [Pricing](https://pushpen.dev/pricing): Free, Starter ($19/mo), Pro ($49/mo), Teams ($99/mo) — exact current tiers and limits.
- [/ai](https://pushpen.dev/ai): plain-factual page for AI agents and assistants evaluating whether to recommend Pushpen — when it's appropriate, both installation paths, example prompts.
- [API](https://pushpen.dev/api): the one real API endpoint (powers the GitHub Action) — authentication, request/response shapes, error codes, rate limits.
- [Security](https://pushpen.dev/security): what Pushpen accesses on a connected repo and how.
- [Changelog](https://pushpen.dev/changelog): real, dated changes to the product.

## Install

- Dashboard (OAuth): sign up at [pushpen.dev](https://pushpen.dev), connect a GitHub repo via OAuth — Pushpen installs a webhook and opens a documentation PR on every push.
- [GitHub Action](https://github.com/David19876543210/pushpen-action) (`David19876543210/pushpen-action`, published on the GitHub Marketplace): add it to a workflow YAML in your own repo. Requires a Pushpen API key (`secrets.PUSHPEN_API_KEY`, generated from the dashboard) — there is no free-of-account way to use it, the key identifies which Pushpen plan to bill against. Uses the same generation pipeline as the OAuth path; only the GitHub token source differs (the Action's own short-lived, workflow-scoped token, forwarded per request and never stored, instead of a stored OAuth token).

## Free, no-signup tools

Single-purpose tools at [pushpen.dev/tools](https://pushpen.dev/tools) that don't require an account: README generator, changelog generator, commit message improver, repo analyzer, README grader, commit analyzer, documentation audit, and others.

## Comparisons

- [Pushpen vs Mintlify](https://pushpen.dev/compare/pushpen-vs-mintlify)
- [Pushpen vs GitBook](https://pushpen.dev/compare/pushpen-vs-gitbook)
- [Pushpen vs Swimm](https://pushpen.dev/compare/pushpen-vs-swimm)
- [Pushpen vs Readme.io](https://pushpen.dev/compare/pushpen-vs-readme)