R
RunScribe
FeaturesHow It WorksPricingDocs
R
RunScribe

Automated documentation and codebase audits for modern development teams.

Product

  • Features
  • Pricing
  • Docs

Company

  • About
  • Careers
  • Contact

Legal

  • Privacy
  • Terms

RunScribe — Documentation that runs itself. © 2026

PrivacyTerms
IntroductionQuickstartInstallation
Connect RepositoryGenerate DocumentationCustomizationCI/CD IntegrationNew
Documentation

DOCUMENTATION

RunScribe Documentation

Learn how to use RunScribe to automatically generate and maintain documentation for your codebase.

Getting Started

Getting Started

Quickstart Guide

Get up and running with RunScribe in under 5 minutes. Connect your repository and generate your first documentation.

5 min read
Guides

Connect Your Repository

Learn how to connect your GitHub, GitLab, or Bitbucket repository to RunScribe for automated documentation.

3 min read
Guides

Generate Documentation

Understand how RunScribe analyzes your codebase and generates comprehensive documentation automatically.

7 min read

Documentation Types

Features

File-Level Documentation

Clear explanations for every file, function, class, and their responsibilities in your codebase.

4 min read
Features

Architecture Documentation

High-level system overviews, data flow diagrams, and dependency maps for your entire project.

6 min read
Features

API Documentation

Automatically generated API references with inputs, outputs, schemas, errors, and usage examples.

5 min read
Features

Mermaid Diagrams

Visual representations of your architecture, component trees, and data flow using Mermaid diagrams.

4 min read

API Reference

API

Authentication

Learn how to authenticate with the RunScribe API using API keys and OAuth tokens.

3 min read
API

Repositories API

Manage your connected repositories, trigger documentation runs, and configure settings via API.

5 min read