update Open Source Docs from Roblox internal teams

Author: rbx-open-source-docs[bot]

content/common/navigation/engine/guides.yaml

@@ -419,7 +419,7 @@ navigation:
         section:
           - title: Overview
             path: /chat/in-experience-text-chat
-          - title: Guidelies
+          - title: Guidelines
             path: /chat/guidelines
           - title: Chat window
             path: /chat/chat-window
@@ -428,14 +428,14 @@ navigation:
           - title: Examples
             path: /chat/examples/simple-custom-frontend-ui
             section:
-              - title: Custom UI
-                path: /chat/examples/simple-custom-frontend-ui
               #- title: Custom System Messages
               #  path: /chat/examples/custom-system-messages
               - title: Chat tags
                 path: /chat/examples/group-chat-tags
               - title: Proximity chat
                 path: /chat/examples/proximity-chat
+              - title: Custom UI
+                path: /chat/examples/simple-custom-frontend-ui
               - title: Custom chat commands
                 path: /chat/examples/custom-text-chat-commands
           - title: Legacy chat system

content/common/navigation/scale/analytics.yaml

@@ -20,6 +20,8 @@ navigation:
     path: /production/analytics/acquisition
   - title: Audience
     path: /production/analytics/audience
+  - title: Feedback
+    path: /production/analytics/feedback
   - title: Monetization
     path: /production/analytics/monetization
 

content/en-us/assets/players/in-experience-text-chat/TextChat-Example1.png

@@ -285,7 +285,7 @@ Appearance of the **channel tabs** is customizable through `Class.ChannelTabsCon
 
 ## Customize messages
 
-You can customize the appearance of chat message bodies and prefixes using `Class.ChatWindowMessageProperties` and `Class.TextChatService.OnChatWindowAdded` callbacks without overriding the existing UI. The customization options let you modify the appearance of chat messages to match your experience's theme, and you can also sort or highlight messages from different user groups by adding chat tags and coloring prefixes.
+You can customize the appearance of chat message bodies and prefixes using `Class.ChatWindowMessageProperties` and `Class.TextChatService.OnChatWindowAdded` callbacks without overriding the existing UI. The customization options let you modify the appearance of chat messages to match your experience's theme, and you can also sort or highlight messages from different user groups by coloring prefixes or adding [chat tags](./examples/group-chat-tags.md).
 
 <Alert severity="info">
 `Class.ChatWindowMessageProperties` and `Class.TextChatService.OnChatWindowAdded|OnChatWindowAdded` only affect the appearance of messages in the chat window. To customize chat bubbles, see [Bubble Chat](../chat/bubble-chat.md).
@@ -354,35 +354,6 @@ TextChatService.OnChatWindowAdded = function(message: TextChatMessage)
 end
 ```
 
-### Add chat tags
-
-If your experience has users with special [attributes](../studio/properties.md#instance-attributes) like VIP status, you can attach chat tags wrapped in brackets to the front of user messages to highlight their messages. The following `Class.LocalScript` in `Class.StarterPlayerScripts` examines all `Class.Player` instances representing users in your experience and appends VIP chat tags to those with the `IsVIP` attribute.
-
-<img src="../assets/players/in-experience-text-chat/Chat-Tag-VIP.png" width="780" alt="VIP chat tag appended to user name in the chat window." />
-
-```lua title="Appending Chat Tags"
-local TextChatService = game:GetService("TextChatService")
-local Players = game:GetService("Players")
-
-local chatWindowConfiguration = TextChatService.ChatWindowConfiguration
-
-TextChatService.OnChatWindowAdded = function(message: TextChatMessage)
-	local properties = chatWindowConfiguration:DeriveNewMessageProperties()
-
-	if message.TextSource then
-		local player = Players:GetPlayerByUserId(message.TextSource.UserId)
-		if player:GetAttribute("IsVIP") then
-			properties.PrefixText = "[VIP] " .. message.PrefixText
-
-			properties.PrefixTextProperties = chatWindowConfiguration:DeriveNewMessageProperties()
-			properties.PrefixTextProperties.TextColor3 = Color3.fromRGB(255, 125, 50)
-		end
-	end
-
-	return properties
-end
-```
-
 ### Rich text customization
 
 Rich text [font color tags](../ui/rich-text.md#supported-tags) can be used to format chat messages, helpful if you want to apply formatting to very specific parts of the message. Note that rich text does not support gradients, but the following code sample shows how you can move the user name (stored in `Class.TextChatMessage.PrefixText`) into the message body and then apply rich text tagging to only the name portion.
@@ -444,7 +415,7 @@ For a more detailed guide on how to customize the appearance of system messages,
 
 #### Default system messages
 
-When `Class.TextChatService.CreateDefaultTextChannels` is true, one of the default text channels is the RBXSystem channel. The default chat scripts automatically display system messages in this channel. You can customize the appearance of these messages using the `Class.TextChannel.OnIncomingMessage` callback.
+When `Class.TextChatService.CreateDefaultTextChannels` is `true`, one of the default text channels is the `RBXSystem` channel. The default chat scripts automatically display system messages in this channel. You can customize the appearance of these messages using the `Class.TextChannel.OnIncomingMessage` callback.
 
 You might want to customize or alter the system messages that are automatically emitted by the chat system. Since the default system messages are localized for users, you should reference them by `TextChatMessage.Metadata` in your [text chat callbacks](../chat/in-experience-text-chat.md#text-chat-hooks-and-callbacks) if you wish to customize their appearance.
 

content/en-us/assets/players/in-experience-text-chat/TextChat-Example2.png

@@ -3,53 +3,53 @@ title: Custom text chat commands
 description: Learn how to create custom chat commands.
 ---
 
-`Class.TextChatService` has built-in chat commands for common purposes, such as muting other players and using avatar emotes. You can enable them by setting `Class.TextChatService.CreateDefaultCommands` to true in the Studio properties panel.
+`Class.TextChatService` has built-in chat commands for common purposes, such as muting other players and using avatar emotes. You can enable them by setting `Class.TextChatService.CreateDefaultCommands|CreateDefaultCommands` to `true` in Studio's **Properties** window.
 
 You can also add custom commands using `Class.TextChatCommand`. Users sending a defined command in the chat input bar trigger a callback defined by `Class.TextChatCommand.Triggered` to perform your customized actions.
 
 The following example shows how to create a chat command that allows players to increase or decrease their character's size when they input `/super` or `/mini`.
 
 1. Add a `Class.TextChatCommand` instance inside `Class.TextChatService`.
-2. Rename it SizeCommand.
+2. Rename it to **SizeCommand**.
 
    <img src="../../assets/studio/explorer/TextChatService-TextChatCommand.png" width="320" />
 
-3. Set its PrimaryAlias property to `/super` and its SecondaryAlias to `/mini`.
+3. Set its `Class.TextChatCommand.PrimaryAlias|PrimaryAlias` property to `/super` and its `Class.TextChatCommand.SecondaryAlias|SecondaryAlias` to `/mini`.
 
    <img src="../../assets/players/in-experience-text-chat/TextChatCommand-Aliases.png" width="320" />
 
 4. Insert the following `Class.Script` inside `Class.ServerScriptService` to define a callback for the chat command that scales the character's size:
 
-   ```lua title="Script" highlight="4,6"
-   local TextChatService = game:GetService("TextChatService")
-   local Players = game:GetService("Players")
-
-   local sizeCommand: TextChatCommand = TextChatService:WaitForChild("SizeCommand")
-
-   sizeCommand.Triggered:Connect(function(textSource, message)
-    local scaleMult = 1
-    local messageWords = string.split(message, " ")
-    if messageWords[1] == "/super" then
-      scaleMult = 2
-    elseif messageWords[1] == "/mini" then
-      scaleMult = 0.5
-    end
-
-    local player = Players:GetPlayerByUserId(textSource.UserId)
-    if player then
-      local character = player.Character
-      if character then
-        local humanoid = character:FindFirstChildWhichIsA("Humanoid")
-        if humanoid then
-          for _, child in humanoid:GetChildren() do
-            if child:IsA("NumberValue") then
-              child.Value *= scaleMult
-            end
-          end
-        end
-      end
-    end
-   end)
-   ```
+		```lua title="Script" highlight="4,6"
+		local TextChatService = game:GetService("TextChatService")
+		local Players = game:GetService("Players")
+
+		local sizeCommand: TextChatCommand = TextChatService:WaitForChild("SizeCommand")
+
+		sizeCommand.Triggered:Connect(function(textSource, message)
+			local scaleMult = 1
+			local messageWords = string.split(message, " ")
+			if messageWords[1] == "/super" then
+				scaleMult = 2
+			elseif messageWords[1] == "/mini" then
+				scaleMult = 0.5
+			end
+
+			local player = Players:GetPlayerByUserId(textSource.UserId)
+			if player then
+				local character = player.Character
+				if character then
+					local humanoid = character:FindFirstChildWhichIsA("Humanoid")
+					if humanoid then
+						for _, child in humanoid:GetChildren() do
+							if child:IsA("NumberValue") then
+								child.Value *= scaleMult
+							end
+						end
+					end
+				end
+			end
+		end)
+		```
 
    <video controls src="../../assets/players/in-experience-text-chat/Text-Custom-Command.mp4" width="90%"></video>

content/en-us/chat/chat-window.md

@@ -1,58 +1,56 @@
 ---
-title: Assign chat tags by group membership
-description: Example of how to assign chat tags to players based on their membership of a group.
+title: Assign chat tags
+description: Example of how to assign chat tags to players based on their membership in a group.
 ---
 
-This example demonstrates how to assign chat tags to players based on their membership of a group. Chat tags are a way to visually identify a player in the chat window and useful for indicating a player's role, status, or group membership.
+This example demonstrates how to assign **chat tags** to players based on their membership in a [group](../../projects/groups.md). Chat tags are a way to visually identify a player in the chat window and useful for indicating a player's role or status.
 
-First, create a script in ServerScriptService, and add the following code to it:
+<img src="../../assets/players/in-experience-text-chat/Chat-Tag-VIP.png" width="780" alt="VIP chat tag appended to user name in the chat window." />
 
-```lua title="Server"
-local Players = game:GetService("Players")
+Because [text chat callbacks](../in-experience-text-chat.md#text-chat-hooks-and-callbacks) expect a non-yielding callback, attempting to query the group membership status of a player in the `Class.TextChatService.OnIncomingMessage` callback is not recommended, as it may cause the chat system to hang or become unresponsive.
 
--- Replace 123456 with the Group ID you want to check for
-local groupId = 123456
+Instead, set a player [attribute](../../studio/properties.md#instance-attributes) when they join the server. Setting an attribute lets you reuse the player's status in other parts of your experience such as allowing access to particular areas or providing bonus experience.
 
-Players.PlayerAdded:Connect(function(player)
-  local success, isInGroup = pcall(function()
-    return player:IsInGroup(groupId)
-  end)
+1. Create a `Class.Script` in `Class.ServerScriptService` and add the following code to it:
 
-  if success and isInGroup then
-    player:SetAttribute("isFanClubMember", true)
-  else
-    player:SetAttribute("isFanClubMember", false)
-  end
-end)
-```
+		```lua title="Server"
+		local Players = game:GetService("Players")
 
-Because [Text Chat callbacks](../in-experience-text-chat.md#text-chat-hooks-and-callbacks) expect a non-yielding callback, attempting to query the group membership status of a player in the `TextChatService.OnIncomingMessage` callback is not recommended, as it may cause the chat system to hang or become unresponsive.
+		-- Replace 123456 with the group ID you want to check for
+		local groupID = 123456
 
-Instead, set a player attribute when they join the server. Setting an attribute lets you reuse this information in other parts of your experience. For example, in addition to setting chat tag, you might use it to allow access to particular areas or provide bonus experience.
+		Players.PlayerAdded:Connect(function(player)
+			local success, isInGroup = pcall(function()
+				return player:IsInGroup(groupID)
+			end)
 
-Then create a `LocalScript` in **StartCharacterScripts**, and add the following code to it to display a **\[Fan\]** tag in the chat window:
+			if success and isInGroup then
+				player:SetAttribute("IsVIP", true)
+			else
+				player:SetAttribute("IsVIP", false)
+			end
+		end)
+		```
 
-```lua title="Client"
-local Players = game:GetService("Players")
-local TextChatService = game:GetService("TextChatService")
+2. Create a `Class.LocalScript` in `Class.StarterPlayer` ⟩ `Class.StarterCharacterScripts` and add the following code to display a **\[VIP\]** tag in the chat window:
 
+		```lua title="Client"
+		local Players = game:GetService("Players")
+		local TextChatService = game:GetService("TextChatService")
 
-TextChatService.OnIncomingMessage = function(message: TextChatMessage)
-  local textSource = message.TextSource
-  if textSource then
-    local player = Players:GetPlayerByUserId(textSource.UserId)
-    if player then
-      local isFanClubMember = player:GetAttribute("isFanClubMember")
-      if isFanClubMember == true then
-        local overrideProperties = Instance.new("TextChatMessageProperties")
-        overrideProperties.PrefixText = `[Fan] {message.PrefixText}`
-        return overrideProperties
-      end
-    end
-  end
+		TextChatService.OnIncomingMessage = function(message: TextChatMessage)
+			local textSource = message.TextSource
+			if textSource then
+				local player = Players:GetPlayerByUserId(textSource.UserId)
+				if player then
+					if player:GetAttribute("IsVIP") == true then
+						local overrideProperties = Instance.new("TextChatMessageProperties")
+						overrideProperties.PrefixText = "[VIP] " .. message.PrefixText
+						return overrideProperties
+					end
+				end
+			end
 
-  return nil
-end
-```
-
-![Chat window showing the Fan tag.](../../assets/players/in-experience-text-chat/TextChat-Group-Tag.png)
+			return nil
+		end
+		```

content/en-us/chat/examples/custom-text-chat-commands.md

@@ -3,41 +3,42 @@ title: Proximity-based chat
 description: Learn how to implement exclusive chat for users who are close to each other in locations using the TextChatService.
 ---
 
-This example shows how to implement an exclusive chat for users who are near each other in the game world. It extends the callback with a function using `Class.TextSource` to identify the locations of a user who might be a potential message receiver. If this function returns false, it means that the user locates further than the preset valid range from the message sender, so the system doesn't deliver the message to that user. Add the following to a `Class.Script` in ServerScriptStorage:
+This example shows how to implement an exclusive chat for users who are near each other in the game world. It extends the callback with a function using `Class.TextSource` to identify the locations of a user who might be a potential message receiver. If this function returns `false`, it means that the user locates further than the preset valid range from the message sender, so the system doesn't deliver the message to that user.
+
+Add the following to a `Class.Script` in `Class.ServerScriptService`:
 
 ```lua title="Server"
--- Get the text chat and players services
 local TextChatService = game:GetService("TextChatService")
 local Players = game:GetService("Players")
 
--- Get the chat channel for proximity-based chat.
--- This example uses the general channel. You can replace this with a dedicated channel.
+-- Get the chat channel for proximity-based chat
+-- You can replace this general channel with a dedicated channel
 local generalChannel: TextChannel = TextChatService:WaitForChild("TextChannels").RBXGeneral
 
--- Define a function to get the position of a user's character.
+-- Function to get the position of a user's character
 local function getPositionFromUserId(userId: number)
-  -- Get the player associated with the given userId.
-  local targetPlayer = Players:GetPlayerByUserId(userId)
-
-  -- If the player exists, get their character's position.
-  if targetPlayer then
-    local targetCharacter = targetPlayer.Character
-    if targetCharacter then
-      return targetCharacter:GetPivot().Position
-    end
-  end
-
-  -- Return a default position if the player or character cannot be found.
-  return Vector3.zero
+	-- Get the player associated with the given user ID
+	local targetPlayer = Players:GetPlayerByUserId(userId)
+
+	-- If the player exists, get their character's position
+	if targetPlayer then
+		local targetCharacter = targetPlayer.Character
+		if targetCharacter then
+			return targetCharacter:GetPivot().Position
+		end
+	end
+
+	-- Return a default position if the player or character cannot be found
+	return Vector3.zero
 end
 
--- Set the ShouldDeliverCallback for the general channel to control message delivery.
+-- Set the callback for the general channel to control message delivery
 generalChannel.ShouldDeliverCallback = function(textChatMessage: TextChatMessage, targetTextSource: TextSource)
-  -- Get the positions of the message sender and target.
-  local sourcePos = getPositionFromUserId(textChatMessage.TextSource.UserId)
-  local targetPos = getPositionFromUserId(targetTextSource.UserId)
+	-- Get the positions of the message sender and target
+	local sourcePos = getPositionFromUserId(textChatMessage.TextSource.UserId)
+	local targetPos = getPositionFromUserId(targetTextSource.UserId)
 
-  -- If the distance between the sender and target is less than 50 units, deliver the message.
-  return (targetPos - sourcePos).Magnitude < 50
+	-- Deliver message if distance between sender and target is less than 50 units
+	return (targetPos - sourcePos).Magnitude < 50
 end
 ```