Overview

ReadMe is built around a flexible authoring model that adapts to unique workflows. You can write and manage all of your documentation directly in the ReadMe platform. Alternatively, content can live entirely in your codebase and sync to ReadMe. Most teams combine these approaches by using ReadMe features in ways that fit their contributor preferences, tooling, and release processes.

The sections below covers starting points that accommodate unique documentation workflows.

Define Your ReadMe Workflow

Most enterprise teams land on a unique workflow over time as contributor needs diversify. You can start with Write in ReadMe or Docs as Code and switch to the other, or evolve to a Hybrid approach, as your needs change.

If you're unsure where to begin, start by familiarizing yourself with the ReadMe platform. Understanding which tools work for you, how to migrate existing content, and what integrations are available will inform the path that your team ultimately takes.

📘
Need additional support? Contact your CSM or reach out to [email protected] at any stage of setup.

Branching (Write in ReadMe)

Branching enables a fully browser-based authoring workflow.

Contributors create and edit documentation directly in the ReadMe UI. Branching allows multiple authors to work in parallel without conflicts. Combined with version management and review workflows, teams can handle the full content lifecycle without leaving the browser.

Branching

Create and manage parallel documentation branches without conflicts.

Docs Audit

Learn how to leverage AI to monitor documentation.

Reviews

Set up review workflows to approve changes before they go live.

Docs as Code

ReadMe supports a code-first workflow where documentation lives in your repository alongside your codebase.

When changes are pushed to your repository, your ReadMe documentation updates automatically. This flow applies existing CI/CD pipelines and branching strategies to docs the same way they apply to code. This also means documentation authoring is done the same way as software development.

Connect Your Codebase

Sync your repository to ReadMe so docs update automatically on every push.

ReadMe CLI

Use the new CLI to manage and deploy documentation from your local environment.

Documentation Structure

Understand how to organize your docs hierarchy within ReadMe.

Hybrid

Most teams use a mixed workflow that supports both repository-based and browser-based authoring simultaneously.

Bi-directional sync keeps your repository and ReadMe in sync regardless of where edits originate. Changes made in the browser are pushed to the repository; changes merged in the repository are reflected in ReadMe. Both authoring paths remain active and consistent. Standards like MDX (an extension of Markdown) and OpenAPI make it easy to take a hybrid documentation approach.

Branching

Create and manage parallel documentation branches without conflicts.

Connect Your Codebase

Sync your repository to ReadMe so docs update automatically on every push.

AI Assistance

Import and manage your OpenAPI spec to auto-generate API reference docs.