Write API Docs from Your Code

Turn your repository into an accurate API reference, guides and FAQ answers, and catch the doc pages that drifted from what shipped.

About

Get documentation that matches the code: every endpoint, parameter and error read from the source, with examples that run.

What it does

Writes the API reference of a repository: routes or public functions, auth, parameters, responses, errors and a working example each
Drafts product and developer guides that start from what the reader wants to do
Builds or enriches a FAQ from your docs and the questions you actually receive
Explains why a piece of code behaves the way it does, with the files, commits and decisions behind it
Checks what shipped against your docs and drafts the fixes for pages that went stale

What you need

Nothing to start: a public GitHub URL or pasted code is enough
GitHub (optional) to read private repositories, follow merged pull requests and propose docs changes as a pull request

How setup works

You give it a repository and get a first API reference in the first minutes. It then learns who reads your docs, where they live and your house style, and offers a weekly drift check.

What stays in your hands

Nothing is pushed, merged or published without your go-ahead
What the code leaves unclear is flagged as an open question, never guessed

What you will need

GitHub

Coworkers in this template

Technical Writer

Turns your code into accurate API references, guides and FAQ answers, and flags the doc pages that no longer match what shipped.

Apps

Skills · 5

Build the FAQ

Use when asked to create, enrich or update a FAQ from the docs and the questions users actually ask.

Explain how the code works

Use when asked why some code behaves the way it does, how a feature works under the hood, or where a behaviour comes from in the repository.

Find outdated doc pages

Use when asked which docs are outdated, no longer match the code or need updating after a release or a change, and on the weekly drift check.

Write the API reference

Use when asked to document an API, its endpoints or public functions, or to write or update an OpenAPI spec from the code.

+1 more

Scheduled tasks · 1

Weekly docs drift check

At 09:00 AM, only on Monday

Frequently asked questions

Does it need access to my private repository?

Not to start: a public GitHub URL or pasted code is enough. Connect GitHub when you want it to read private repositories, follow merged pull requests and propose docs changes.

Can it publish to my docs site?

It writes in the format your docs use (Markdown, MDX, OpenAPI, docstrings) and proposes the change as a pull request once you say go. If your docs live in Notion, Google Docs or another tool, it can connect the one you use when it is in the Rerun catalogue.

Can it generate an OpenAPI spec?

Yes. Ask for one and it builds or updates the spec from your routes, types and validation, and flags what the code leaves unclear.

How does it find outdated documentation?

It starts from what shipped since the last check (merged pull requests, changelog, diffs to routes, config and public types), searches your docs for every name that changed and lists the pages that no longer match, with evidence and a draft fix.

Will it make things up about my API?

Every statement is traced to the code, a test or a commit. When something is unclear it writes an open question in the draft instead of guessing.

How much does it cost to run?

The template is free. Runs use your Rerun credit.

2,000+ businesses run on Rerun

Hire Coworkers on the ChatGPTplan you already pay for.

1. Plug in your subscription
2. Set up your Coworkers
3. Run your business with Coworkers

Start now for free

Rerun

Run your work on coworkers. Build them, watch them work, and keep your eyes on everything.

What it does

What you need

How setup works

What stays in your hands

Apps

Skills · 5

Scheduled tasks · 1

More SaaS templates

Systems Admin

Incident Manager

DevOps Engineer

Hire Coworkers on the ChatGPTClaudeChatGPTChatGPTplan you already pay for.

Hire Coworkers on the ChatGPTplan you already pay for.