From 9a46f9dca9d4eb0f80e8fe7b1f0defed41840f90 Mon Sep 17 00:00:00 2001
From: Luper Rouch <luper.rouch@gmail.com>
Date: Fri, 23 Feb 2024 10:19:21 +0100
Subject: [PATCH] Add ssr feature note to the book

I wasn't aware of Leptos' SSR build process, and enabled the
`leptos-use` feature globally. Because of this I ended up with the
server version of the functions in the client, which obviously did not
work.
---
 docs/book/src/server_side_rendering.md | 26 +++++++++++++++++++++++---
 1 file changed, 23 insertions(+), 3 deletions(-)

diff --git a/docs/book/src/server_side_rendering.md b/docs/book/src/server_side_rendering.md
index 278c806..e9b577c 100644
--- a/docs/book/src/server_side_rendering.md
+++ b/docs/book/src/server_side_rendering.md
@@ -10,7 +10,7 @@ In your Cargo.toml file add the following:
 
 [features]
 hydrate = [
-    "leptos/hydrate", 
+    "leptos/hydrate",
     ...
 ]
 ssr = [
@@ -30,6 +30,25 @@ find information about these differences in their respective docs under the sect
 If you don't find that section, it means that the function works exactly the same on both, the client
 and the server.
 
+> **Note:** do not enable `leptos-use`'s `ssr` feature directly!
+>
+> ```toml
+> [dependencies]
+> leptos-use = { version = "0.10", features = ["ssr"] }  # do not do this
+> ```
+
+The `ssr` feature is used to select which version of the functions are built.
+Effectively it means your application is built two times: with `ssr` enabled to
+build the server executable, and with `ssr` disabled to build the client's WASM
+binary module.
+
+So if you enable `leptos-use`'s `ssr` feature globally, you will get the server
+version of the functions in the client.
+
+By adding `"leptos-use/ssr"` to the `ssr` feature of your project, it will only
+be enabled when your project is built with `ssr`, and you will get the server
+functions server-side, and the client functions client-side.
+
 ## Functions with Target Elements
 
 A lot of functions like `use_resize_observer` and `use_element_size` are only useful when a target HTML/SVG element is
@@ -47,8 +66,9 @@ use leptos_use::{use_event_listener, use_window};
 
 use_event_listener(use_window(), keyup, |evt| {
     ...
-}); 
+});
 ```
 
 There are some convenience methods provided as well, like `use_document().body()` which
-just propagate a `None` on the server.
\ No newline at end of file
+just propagate a `None` on the server.
+