Getting Started

This guide walks you through installing UptoDocs and seeing your first documentation pull request.

Most users are up and running in under 10 minutes.

Prerequisites

• A GitHub repository
• Write access to the repository
• Documentation in Markdown or MDX (recommended, but not required)

Step 1: Install the UptoDocs GitHub App

1. Go to the GitHub Marketplace
2. Install UptoDocs
3. Select the repository (or repositories) you want UptoDocs to access

UptoDocs only requests the permissions it needs to:

• Read code
• Read & write documentation
• Open pull requests

Nothing is merged automatically.

Step 2: Initial Setup (Automatic)

On installation, UptoDocs will open a pull request that adds a configuration file:

.github/uptodocs.yml

This file controls how UptoDocs behaves and is fully reviewable.

👉 No code is modified at this stage.

Merge the config PR to activate UptoDocs.

Step 3: Make a Code Change

Push a change that affects public behavior, for example:

• A new exported function
• A new component
• A renamed API endpoint
• A changed config option

UptoDocs ignores internal refactors, tests, and build files.

Step 4: Review the Documentation PR

If UptoDocs detects a documentation-relevant change, it will open a pull request like:

📚 Docs: update for recent code changes

Inside the PR you'll see:

• Only relevant doc updates
• Clear commit messages
• An explanation of why the docs changed

You can:

• Review
• Edit
• Request changes
• Or close the PR if it's not needed

Optional: Manual Commands

You can also control UptoDocs explicitly using comments:

/update-docs

Other useful commands:

• /UptoDocs preview – show what would change without opening a PR
• /UptoDocs bootstrap – generate docs for existing code (Pro)
• /UptoDocs drift – scan for outdated docs (Team)

See the Commands page for full details.

Disabling or Pausing UptoDocs

You can temporarily stop UptoDocs in several ways:

• Close or ignore a PR
• Add ignore rules in UptoDocs.yml
• Uninstall the GitHub App

UptoDocs never forces changes.

What to Expect Next

Once enabled, UptoDocs works quietly in the background:

• Most commits → no action
• Relevant changes → small doc PRs
• No noise, no spam

If you forget UptoDocs exists, that's a good sign.

Need Help?

• Check the FAQ
• Review the Configuration
• Open an issue in the repository

UptoDocs is designed to be predictable, transparent, and safe.

Welcome aboard.