Skip to content

Commit

Permalink
docs(README.md): introduce feature at the head of README
Browse files Browse the repository at this point in the history
  • Loading branch information
KengoTODA committed Sep 15, 2018
1 parent dd121d7 commit 36c7c91
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,18 @@
# A GitHub Probot for Read The Docs (RTD) users
# Get URL of staging document, when you review changes.

[![Build Status](https://travis-ci.com/KengoTODA/rtd-bot.svg?branch=master)](https://travis-ci.com/KengoTODA/rtd-bot)
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

Work with Read The Docs, then you'll find that PR for documentation needs additional steps like:

* running RTD build for your branch manually, to use its result as staging site [like this](https://github.com/spotbugs/spotbugs/pull/697#issue-201455071), or
* sharing screenshot to share the updated document [like this](https://github.com/spotbugs/spotbugs/pull/718#issue-205904835).

This bot automates the first approach; activate RTD build automatically when you made PR that updates `docs/` directory.

![screenshot](screenshot.png)

## Installation

0. Make sure your that your RTD project has been [connected with GitHub repository](https://docs.readthedocs.io/en/latest/getting_started.html#sign-up-and-connect-an-external-account), or [integrated via GitHub webhook](https://docs.readthedocs.io/en/latest/webhooks.html#github).
Expand Down

0 comments on commit 36c7c91

Please sign in to comment.