From 618747e5f8670de75a19324e18c9b3469a6dec44 Mon Sep 17 00:00:00 2001 From: LuLaValva Date: Mon, 30 Sep 2024 08:31:09 -0700 Subject: [PATCH 1/3] docs: add warning about overserialization --- packages/marko/docs/rendering.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/packages/marko/docs/rendering.md b/packages/marko/docs/rendering.md index e830c92f41..ee8a62f0a0 100644 --- a/packages/marko/docs/rendering.md +++ b/packages/marko/docs/rendering.md @@ -263,4 +263,6 @@ app.get("/", (req, res) => { }); ``` +> **Warning:** Ensure that you serialize only data which is necessary for the browser. Serialization is expensive for both server rendering performance and bundle size. + For details, check [#672: “Serialize only input and state on top-level server-rendered UI components”](https://github.com/marko-js/marko/pull/672). From dac6068d53c5eeb875e3e093487c6216acb1402b Mon Sep 17 00:00:00 2001 From: LuLaValva Date: Mon, 30 Sep 2024 08:37:17 -0700 Subject: [PATCH 2/3] chore: add changeset --- .changeset/thin-kangaroos-appear.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/thin-kangaroos-appear.md diff --git a/.changeset/thin-kangaroos-appear.md b/.changeset/thin-kangaroos-appear.md new file mode 100644 index 0000000000..c1019c3266 --- /dev/null +++ b/.changeset/thin-kangaroos-appear.md @@ -0,0 +1,5 @@ +--- +"marko": patch +--- + +Update documentation From 3b0e4415a9058c84eaa83869f88f026fc1b81c8d Mon Sep 17 00:00:00 2001 From: Luke LaValva Date: Mon, 30 Sep 2024 08:42:39 -0700 Subject: [PATCH 3/3] Update message --- packages/marko/docs/rendering.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/marko/docs/rendering.md b/packages/marko/docs/rendering.md index ee8a62f0a0..40ef1777d9 100644 --- a/packages/marko/docs/rendering.md +++ b/packages/marko/docs/rendering.md @@ -263,6 +263,6 @@ app.get("/", (req, res) => { }); ``` -> **Warning:** Ensure that you serialize only data which is necessary for the browser. Serialization is expensive for both server rendering performance and bundle size. +> **Warning:** Ensure that you serialize only data which is necessary for the browser. Serialization is expensive for both server rendering performance and HTML output size. For details, check [#672: “Serialize only input and state on top-level server-rendered UI components”](https://github.com/marko-js/marko/pull/672).