From 3b753d915a96460129fcf1861e802cf75c9ff388 Mon Sep 17 00:00:00 2001
From: Urgau <urgau@numericable.fr>
Date: Tue, 7 Jan 2025 18:54:27 +0100
Subject: [PATCH] Add documentation for rendered link triagebot handler

---
 src/SUMMARY.md                 |  1 +
 src/triagebot/rendered-link.md | 18 ++++++++++++++++++
 2 files changed, 19 insertions(+)
 create mode 100644 src/triagebot/rendered-link.md

diff --git a/src/SUMMARY.md b/src/SUMMARY.md
index 9fb239e9..ba1287c1 100644
--- a/src/SUMMARY.md
+++ b/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)
diff --git a/src/triagebot/rendered-link.md b/src/triagebot/rendered-link.md
new file mode 100644
index 00000000..3b0f85e5
--- /dev/null
+++ b/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).