diff --git a/docs/README.md b/docs/README.md index fe386fc7c4..a33f31fca8 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,7 @@ --- next: docs/hello-world.md -permalink: /docs/ +title: Introduction +layout: docs.liquid --- # Introduction @@ -11,7 +12,7 @@ If you've ever thought, "wouldn't it be cool if GitHub could…"; imma stop you Probot apps are easy to write, deploy, and share. Many of the most popular Probot apps are hosted, so there's nothing for you to deploy and manage. Here are just a few examples of things that have been built with Probot: -{% include docs/examples.html %} +{% include "docs/examples" %} Check out the [featured apps](https://probot.github.io/apps/) or [browse more examples on GitHub](https://github.com/search?q=topic%3Aprobot-app&type=Repositories) diff --git a/docs/assets/probot-setup-wizzard.png b/docs/assets/probot-setup-wizzard.png deleted file mode 100644 index 709dee1244..0000000000 Binary files a/docs/assets/probot-setup-wizzard.png and /dev/null differ diff --git a/docs/best-practices.md b/docs/best-practices.md index e97acee06c..45a92fb39a 100644 --- a/docs/best-practices.md +++ b/docs/best-practices.md @@ -1,3 +1,7 @@ +--- +title: Best practices +--- + # Best practices First and foremost, your app must obey the [The Three Laws of Robotics](https://en.wikipedia.org/wiki/Three_Laws_of_Robotics): diff --git a/docs/configuration.md b/docs/configuration.md index fe45aada6d..437c4eb653 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -1,5 +1,6 @@ --- next: docs/testing.md +title: Configuration --- # Configuration diff --git a/docs/deployment.md b/docs/deployment.md index 71e9469275..f5b12a1428 100644 --- a/docs/deployment.md +++ b/docs/deployment.md @@ -1,5 +1,6 @@ --- next: docs/http.md +title: Deployment --- # Deployment diff --git a/docs/development.md b/docs/development.md index a7ba1966ce..84ad1fb15f 100644 --- a/docs/development.md +++ b/docs/development.md @@ -1,5 +1,6 @@ --- next: docs/webhooks.md +title: Developing an app --- # Developing an app diff --git a/docs/extensions.md b/docs/extensions.md index 2a4bf6d066..cffa0156ad 100644 --- a/docs/extensions.md +++ b/docs/extensions.md @@ -1,5 +1,6 @@ --- next: docs/persistence.md +title: Extensions --- # Extensions diff --git a/docs/github-api.md b/docs/github-api.md index fd77ff6f00..f557bc7c65 100644 --- a/docs/github-api.md +++ b/docs/github-api.md @@ -1,5 +1,6 @@ --- next: docs/configuration.md +title: Interacting with GitHub --- # Interacting with GitHub diff --git a/docs/hello-world.md b/docs/hello-world.md index 80177320af..2da8a26fa2 100644 --- a/docs/hello-world.md +++ b/docs/hello-world.md @@ -1,5 +1,6 @@ --- next: docs/development.md +title: Hello World --- # Hello world diff --git a/docs/http.md b/docs/http.md index 09a10181f4..e4a4a1b099 100644 --- a/docs/http.md +++ b/docs/http.md @@ -1,5 +1,6 @@ --- next: docs/pagination.md +title: HTTP routes --- # HTTP routes diff --git a/docs/logging.md b/docs/logging.md index 1b7510abe9..5210cf48d9 100644 --- a/docs/logging.md +++ b/docs/logging.md @@ -1,5 +1,6 @@ --- next: docs/deployment.md +title: Logging --- # Logging diff --git a/docs/pagination.md b/docs/pagination.md index 7c191fa847..0ab74688b5 100644 --- a/docs/pagination.md +++ b/docs/pagination.md @@ -1,5 +1,6 @@ --- next: docs/extensions.md +title: Pagination --- # Pagination diff --git a/docs/persistence.md b/docs/persistence.md index 17cedf0da7..19f284b64c 100644 --- a/docs/persistence.md +++ b/docs/persistence.md @@ -1,5 +1,6 @@ --- next: docs/best-practices.md +title: Persistence --- # Persistence diff --git a/docs/simulating-webhooks.md b/docs/simulating-webhooks.md index 894cb69f88..69adcd3891 100644 --- a/docs/simulating-webhooks.md +++ b/docs/simulating-webhooks.md @@ -1,5 +1,6 @@ --- next: docs/logging.md +title: Simulate receiving webhooks --- # Simulate receiving webhooks diff --git a/docs/testing.md b/docs/testing.md index c31b98ffde..fd746e08eb 100644 --- a/docs/testing.md +++ b/docs/testing.md @@ -1,5 +1,6 @@ --- next: docs/simulating-webhooks.md +title: Testing --- # Testing diff --git a/docs/webhooks.md b/docs/webhooks.md index b09552902b..e11b42ece6 100644 --- a/docs/webhooks.md +++ b/docs/webhooks.md @@ -1,5 +1,6 @@ --- next: docs/github-api.md +title: Receiving webhooks --- # Receiving webhooks