Merge pull request #797 from Urgau/rendered_link-add

Add documentation for rendered link triagebot handler

Author: ehuss

src/SUMMARY.md

@@ -30,6 +30,7 @@
     - [Note](./triagebot/note.md)
     - [Notifications](./triagebot/notifications.md)
     - [Pinging](./triagebot/pinging.md)
+    - [Rendered link](./triagebot/rendered-link.md)
     - [Requesting Prioritization](./triagebot/requesting-prioritization.md)
     - [Review Changes Requested](./triagebot/review-submitted.md)
     - [Review Requested](./triagebot/review-requested.md)

src/triagebot/rendered-link.md

@@ -0,0 +1,18 @@
+# Rendered link
+
+Rendered links are simple hyperlinks that are automatically added (and updated) to a PR description by triagebot.
+
+## Configuration
+
+This feature is enabled on a repository by having a `[rendered-link]` table in `triagebot.toml`:
+
+```toml
+[rendered-link]
+trigger-files = ["posts/"]
+```
+
+The `trigger-files` key configures which directories are watched for modification, with the "Rendered link" pointing to the first file matching.
+
+## Implementation
+
+See [`src/handlers/rendered_link.rs`](https://github.com/rust-lang/triagebot/blob/HEAD/src/handlers/rendered_link.rs).