Merge pull request cake-contrib#118 from pascalberger/feature/doc-improv

Improve documentation
pascalberger · Sep 26, 2020 · 4f2637d · 4f2637d
2 parents 7e2c84f + 11e0948
commit 4f2637d
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 3 deletions.
diff --git a/docs/examples/appveyor-messages.png → docs/appveyor-messages.png b/docs/examples/appveyor-messages.png → docs/appveyor-messages.png
diff --git a/docs/examples/write-messages.md b/docs/examples/write-messages.md
@@ -41,6 +41,6 @@ Task("ReportIssuesToAppVeyor").Does(() =>
 
 The output will look similar to this:
 
-![AppVeyor messages](appveyor-messages.png "AppVeyor messages")
+![AppVeyor messages](../appveyor-messages.png "AppVeyor messages")
 
 [AppVeyorBuilds]: ../../../../api/Cake.Issues.PullRequests.AppVeyor/AppVeyorBuildsAliases/
diff --git a/docs/features.md b/docs/features.md
@@ -3,7 +3,9 @@ Order: 20
 Title: Features
 Description: Features of the Cake.Issues.PullRequests.AppVeyor addin.
 ---
-The [Cake.Issues.PullRequests.AppVeyor addin] provides the following features.
+The [Cake.Issues.PullRequests.AppVeyor addin] reports issues as messages to AppVeyor builds.
+
+![AppVeyor messages](appveyor-messages.png "AppVeyor messages")
 
 :::{.alert .alert-info}
 There's a [demo repository] available which you can fork and to which you can create pull requests to test the integration functionality.
@@ -12,6 +14,8 @@ There's a [demo repository] available which you can fork and to which you can cr
 # Basic features
 
 * Reports issues as messages to AppVeyor builds.
+* Messages can be written as comment to GitHub pull requests.
+  See [GitHub pull request integration] for an example.
 
 # Supported capabilities
 
@@ -24,4 +28,5 @@ The [Cake.Issues.PullRequests.AppVeyor addin] doesn't support any additional cap
 | <span class="glyphicon glyphicon-remove" style="color:red"></span> | Filtering by modified files    |                                |
 
 [demo repository]: https://github.com/pascalberger/Cake.Issues-Demo
-[Cake.Issues.PullRequests.AppVeyor addin]: https://www.nuget.org/packages/Cake.Issues.PullRequests.AppVeyor
+[Cake.Issues.PullRequests.AppVeyor addin]: https://www.nuget.org/packages/Cake.Issues.PullRequests.AppVeyor
+[GitHub pull request integration]: ./examples/github-pullrequest-integration