From e1cbfd4d1bd9b31c1bc7e44cada10ffcc91190c8 Mon Sep 17 00:00:00 2001
From: Helen Lin <helen.lin@shopify.com>
Date: Thu, 9 Jan 2025 10:26:18 -0800
Subject: [PATCH] add comment

---
 app/root.tsx | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/app/root.tsx b/app/root.tsx
index 0e72a6a..9d0c1b6 100644
--- a/app/root.tsx
+++ b/app/root.tsx
@@ -55,6 +55,15 @@ export const shouldRevalidate: ShouldRevalidateFunction = ({
   return false;
 };
 
+/**
+ * The link to the main stylesheet is purposely not in this list. Instead, it is added
+ * in the Layout function.
+ *
+ * This is to avoid a development bug where after an edit/save, navigating to another
+ * link will cause page rendering error "failed to execute 'insertBefore' on 'Node'".
+ *
+ * This is a workaround until this is fixed in the foundational library.
+ */
 export const links: LinksFunction = () => {
   return [
     {