chore (ts client): Add link to troubleshooting guide in the MissingHe…

…adersError error (#2016)
electric-sql · Nov 21, 2024 · 1faa79b · 1faa79b
1 parent 9718ccc
commit 1faa79b
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 3 deletions.
diff --git a/.changeset/orange-hornets-sneeze.md b/.changeset/orange-hornets-sneeze.md
@@ -0,0 +1,5 @@
+---
+"@electric-sql/client": patch
+---
+
+Add link to troubleshooting guide in the MissingHeadersError.
diff --git a/packages/typescript-client/src/error.ts b/packages/typescript-client/src/error.ts
@@ -56,6 +56,7 @@ export class MissingHeadersError extends Error {
       msg += `- ${h}\n`
     })
     msg += `\nThis is often due to a proxy not setting CORS correctly so that all Electric headers can be read by the client.`
+    msg += `\nFor more information visit the troubleshooting guide: /docs/guides/troubleshooting/missing-headers`
     super(msg)
   }
 }
diff --git a/website/public/_redirects b/website/public/_redirects
@@ -38,9 +38,10 @@ https://next.electric-sql.com/* https://electric-sql.com/:splat 301!
 
 # Shortpaths for nice links
 
-/docs                           /docs/intro
-/intro                          /docs/intro
-/examples                       https://github.com/electric-sql/electric/tree/main/examples
+/docs                                        /docs/intro
+/intro                                       /docs/intro
+/examples                                    https://github.com/electric-sql/electric/tree/main/examples
+/docs/guides/troubleshooting/missing-headers /docs/guides/troubleshooting#missing-headers-mdash-why-is-the-client-complaining-about-missing-headers
 
 # More links from legacy site