From 3dda1f3021aba5c479ba2bb7513f5be2fd8b443d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Rasmus=20Skytte=20Randl=C3=B8v?=
 <rasmusskytteeriksen@gmail.com>
Date: Tue, 29 Oct 2024 10:43:02 +0100
Subject: [PATCH] docs(pkgdown): Add note that local rendering is unchanged

---
 workflows/README.md | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/workflows/README.md b/workflows/README.md
index cd6bbf5..16a0fe4 100644
--- a/workflows/README.md
+++ b/workflows/README.md
@@ -129,6 +129,8 @@ Generates the `pkgdown` documentation for your package.
 > Specifically, it adds auto-linking to R6 object
 > - `?MyR6Class` is rendered without the `?` and links to `MyR6Class`.
 > - `?MyR6Class$method()` is rendered as `method()` and links to the method of `MyR6Class`
+> Notably, these changes are only done on Github.com.
+> When rendering the documentation locally, the code blocks will not be changed.
 
 #### Outcome
 The output of `pkgdown` is stored as an artifact on github.