From 1bc5defd9c03f17148d1139cc91acd2a90ac5437 Mon Sep 17 00:00:00 2001 From: daimond113 Date: Sun, 16 Feb 2025 14:23:47 +0100 Subject: [PATCH] docs: document roblox_server target --- docs/src/content/docs/guides/roblox.mdx | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/src/content/docs/guides/roblox.mdx b/docs/src/content/docs/guides/roblox.mdx index fef3a17..d6d4a9f 100644 --- a/docs/src/content/docs/guides/roblox.mdx +++ b/docs/src/content/docs/guides/roblox.mdx @@ -230,3 +230,19 @@ Whereas with pesde, it looks like this: - dependency (roblox_packages/dependency.luau) + +### The `roblox_server` target + +Although optimizing your server-only dependency using the `roblox_server` target +might sound like a good idea it is not recommended, since it complicates +linking and makes your package unnecessarily harder to use. On a public registry +it is also redundant, since the package can be downloaded by anyone. Syncing +the scripts to the client may also come up as a reason, but it is a +micro-optimization which is very hard to observe, so it is unnecessary. + +The target exists for a reason, that is +[private registries](/guides/self-hosting-registries). You might want to have +internal packages, such as configs or otherwise sensitive code which you do not +want clients to see. This is where the `roblox_server` target comes in handy. +If you're not using a private registry you should use the standard `roblox` +target instead.