Installation

This page explains exactly how UptoDocs is installed, what permissions it requires, and what happens in your repository.

UptoDocs is designed to be safe, explicit, and reversible.

Installing from the GitHub Marketplace

1. Visit the GitHub Marketplace
2. Search for UptoDocs
3. Click Install
4. Choose:
   • All repositories, or
   • Only selected repositories

You can change this selection at any time from GitHub App settings.

Repository Selection

UptoDocs only operates on repositories you explicitly allow.

For each selected repository, UptoDocs can:

• Read code
• Read documentation
• Open pull requests

If a repository is removed from the app's access list, UptoDocs immediately stops acting on it.

Permissions (Important)

UptoDocs requests the minimum required permissions to function safely.

Repository permissions

• Contents (Read & Write)
  Used to read code, read documentation, and propose documentation changes via PRs.

• Pull Requests (Read & Write)
  Used to open and update documentation pull requests.

• Issues (Write)
  Used for optional notifications (e.g. upgrade notices, drift reports).

• Metadata (Read)
  Required by GitHub for basic repository access.

UptoDocs does not:

• Execute your code
• Modify runtime behavior
• Access secrets
• Merge pull requests automatically

What Happens on Install

After installation, UptoDocs performs a single, safe action:

✅ Configuration Pull Request

UptoDocs opens a pull request that adds:

.github/uptodocs.yml

This file controls how UptoDocs behaves.

• No code files are changed
• No documentation is modified yet
• Nothing is activated until you merge this PR

You are always in control.

After Installation

Once the configuration PR is merged:

• UptoDocs starts listening for relevant code changes
• Most commits result in no action
• Only public-facing changes trigger documentation updates

UptoDocs is intentionally quiet.

Uninstalling UptoDocs

You can uninstall UptoDocs at any time.

To uninstall:

1. Go to GitHub → Settings → Applications
2. Find UptoDocs
3. Click Uninstall

After uninstall:

• No further actions are taken
• Existing PRs remain untouched
• No data is retained
• The .github/UptoDocs.yml file is left intact and can be deleted manually if desired

Summary

• Installation is explicit and reversible
• Permissions are minimal and transparent
• No code is modified on install
• Documentation changes always go through PRs

If you are unsure, install UptoDocs on a single repository first.