Skip to content

Commit 554942e

Browse files
update Open Source Docs from Roblox internal teams
1 parent 37643f2 commit 554942e

File tree

13 files changed

+32
-30
lines changed

13 files changed

+32
-30
lines changed

content/en-us/assistant/guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ description: How to use Assistant to help build, grow, and monetize your creatio
1717

1818
## Studio features
1919

20-
You can access Assistant from [Studio](../studio/index.md) and the [documentation](/assistant), but Studio has the larger set of features. In Studio, Assistant consists of a large language model (LLM) that generates code and a run-command module (similar to the existing [command bar](../studio/ui-overview.md#command-bar)) that runs code.
20+
You can access Assistant from [Studio](../studio/index.md) and the [documentation](https://create.roblox.com/docs/assistant), but Studio has the larger set of features. In Studio, Assistant consists of a large language model (LLM) that generates code and a run-command module (similar to the existing [command bar](../studio/ui-overview.md#command-bar)) that runs code.
2121

2222
As a result, Assistant can act directly on your data model, such as inserting and modifying objects, writing and inserting scripts, and automating repetitive tasks like modifying properties in bulk.
2323

content/en-us/cloud-services/data-stores/manage-data-stores.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,7 @@ Serialization and deserialization support the following Lua data types:
248248
- [Tables](../../luau/tables.md)
249249
- Tables must only contain other supported data types
250250
- Numeric keys are translated into strings if the length of the table is 0
251-
- [Buffers](../../reference/engine/libraries/buffer.yaml)
251+
- [Buffers](/reference/engine/libraries/buffer)
252252

253253
If you try to store a data type that serialization doesn't support, you either:
254254

content/en-us/cloud/open-cloud/usage-messaging.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Players.PlayerAdded:Connect(onPlayerAdded)
5757

5858
After [setting up](#set-up-a-topic-for-messaging) a topic, publish a message to your experience's live servers:
5959

60-
1. [Create an API key](./api-keys.md#creating-an-API-key) on [Creator Dashboard](https://create.roblox.com/credentials) and copy it somewhere safe. Make sure you perform the following settings:
60+
1. [Create an API key](./api-keys.md#creating-an-API-key) on [Creator Dashboard](https://create.roblox.com/dashboard/credentials) and copy it somewhere safe. Make sure you perform the following settings:
6161

6262
1. Add **messaging-service** to **Access Permissions**.
6363
2. Select an experience, and add the **universe-messaging-service:publish** operation.

content/en-us/cloud/open-cloud/usage-place-publishing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
title: Usage guide for Place Publishing
2+
title: Usage guide for place publishing
33
description: Explains how to use Open Cloud Place Publishing API to publish places programmatically with version control.
44
---
55

6-
[Place Publishing API](../../reference/cloud/universes-api/v1.json) fulfills the same functionality as [publishing to Roblox](../../production/publishing/publish-experiences-and-places.md) in Studio plus extra permission control and automation in continuous release workflow. You can use this API to update existing places of an experience to a new version, making it useful to automate your publishing workflow. For example, you can call this API from a GitHub action, and it automatically pushes a binary place file to Roblox Cloud after successful integration testing.
6+
The [Place Publishing API](../../reference/cloud/universes-api/v1.json) fulfills the same functionality as [publishing to Roblox](../../production/publishing/publish-experiences-and-places.md) in Studio plus extra permission control and automation in continuous release workflow. You can use this API to update existing places of an experience to a new version, making it useful to automate your publishing workflow. For example, you can call this API from a GitHub action, and it automatically pushes a binary place file to Roblox Cloud after successful integration testing.
77

88
<Alert severity ='info'>
99
This API only supports HTTPS requests.

content/en-us/reference/cloud/assets/v1.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"openapi": "3.0.1",
33
"info": {
44
"title": "Assets API",
5-
"description": "You can send and receive the following request and response payloads to create assets on Roblox. For information on the usage of the API, see the [Usage Guide](../../../cloud/open-cloud/usage-assets.md).",
5+
"description": "You can send and receive the following request and response payloads to create assets on Roblox. For information on the usage of the API, see the [usage guide](../../../cloud/open-cloud/usage-assets.md).",
66
"version": "0.0.1"
77
},
88
"servers": [
@@ -17,7 +17,7 @@
1717
"x-roblox-cloud-api-operation": true,
1818
"x-roblox-cloud-api-operation-name": "Create Asset",
1919
"summary": "Creates an asset with provided content and metadata.",
20-
"description": "Creates an asset with provided content and metadata.\n\nYou can't add [SocialLink](#SocialLink) objects when you create an asset. Instead, use [Update Asset](#PATCH-v1-assets-_assetId_).\n\nProvide the asset attributes, binary asset file path, and content type in the form data. See [Content Types](../../../cloud/open-cloud/usage-assets.md#supported-asset-types-and-limits).",
20+
"description": "Creates an asset with provided content and metadata.\n\nYou can't add [SocialLink](#SocialLink) objects when you create an asset. Instead, use [Update Asset](#PATCH-v1-assets-_assetId_).\n\nProvide the [Asset](#Asset), binary asset file path, and [content type](../../../cloud/open-cloud/usage-assets.md#supported-asset-types-and-limits) in the form data.",
2121
"operationId": "Assets_CreateAsset",
2222
"requestBody": {
2323
"content": {
@@ -32,7 +32,7 @@
3232
"fileContent": {
3333
"type": "string",
3434
"format": "binary",
35-
"description": "The binary asset file path and the content type. See [Content Types](../../../cloud/open-cloud/usage-assets.md#supported-asset-types-and-limits)."
35+
"description": "The binary asset file path and the content type. See [Asset types and limits](../../../cloud/open-cloud/usage-assets.md#supported-asset-types-and-limits)."
3636
}
3737
},
3838
"required": [
@@ -177,7 +177,7 @@
177177
"x-roblox-cloud-api-operation": true,
178178
"x-roblox-cloud-api-operation-name": "Update Asset",
179179
"summary": "Updates an asset with provided content and metadata.",
180-
"description": "Updates an asset with provided content and metadata, including the description, display name, icon, social links, and previews. Currently can only update the content body for **Models**. Icons and Previews must be **Image** assets. Icons must have square dimensions.\n\nProvide the asset attributes, binary asset file path, and content type in the form data. See [Content Types](../../../cloud/open-cloud/usage-assets.md#supported-asset-types-and-limits).",
180+
"description": "Updates an asset with provided content and metadata, including the description, display name, icon, social links, and previews. Currently can only update the content body for **Models**. Icons and Previews must be **Image** assets. Icons must have square dimensions.\n\nProvide the [Asset](#Asset), binary asset file path, and [content type](../../../cloud/open-cloud/usage-assets.md#supported-asset-types-and-limits) in the form data.",
181181
"operationId": "Assets_UpdateAsset",
182182
"parameters": [
183183
{
@@ -212,7 +212,7 @@
212212
"fileContent": {
213213
"type": "string",
214214
"format": "binary",
215-
"description": "The binary asset file path and the content type. See [Content Types](../../../cloud/open-cloud/usage-assets.md#supported-asset-types-and-limits)."
215+
"description": "The binary asset file path and the content type. See [Asset types and limits](../../../cloud/open-cloud/usage-assets.md#supported-asset-types-and-limits)."
216216
}
217217
},
218218
"required": [
@@ -901,7 +901,7 @@
901901
"authorizationCode": {
902902
"authorizationUrl": "https://apis.roblox.com/oauth/v1/authorize",
903903
"tokenUrl": "https://apis.roblox.com/oauth/v1/token",
904-
"refreshUrl": "https://apis.roblox.com/oauth/v1/token",
904+
"refreshUrl": "https://apis.roblox.com/oauth/v1/token",
905905
"scopes": {
906906
"asset:read": "This allows viewing information about your assets.",
907907
"asset:write": "This allows uploading and updating assets to Roblox."

content/en-us/reference/cloud/datastores-api/ordered-v1.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"openapi": "3.0.1",
33
"info": {
4-
"title": "Ordered Data Stores (Beta)",
5-
"description": "This page includes reference documentation for working with ordered data stores. For more information on using the API, see [Handling API Requests for Data Stores](../../../cloud/open-cloud/data-store-api-handling.md) and the [Usage Guide](../../../cloud/open-cloud/usage-data-stores.md).",
4+
"title": "Ordered data stores (beta)",
5+
"description": "This page includes reference documentation for working with ordered data stores. For more information on using the API, see [Handle API requests for data stores](../../../cloud/open-cloud/data-store-api-handling.md) and the [usage guide](../../../cloud/open-cloud/usage-data-stores.md).",
66
"version": "0.0.1"
77
},
88
"servers": [
@@ -399,7 +399,7 @@
399399
{
400400
"name": "allow_missing",
401401
"in": "query",
402-
"description": "The flag to allow the creation of an entry if the entry doesn't exist. See [Allow Missing Flags](../../../cloud/open-cloud/data-store-api-handling.md#allow-missing-flags).",
402+
"description": "The flag to allow the creation of an entry if the entry doesn't exist. See [Allow missing flags](../../../cloud/open-cloud/data-store-api-handling.md#allow-missing-flags).",
403403
"schema": {
404404
"type": "boolean"
405405
}

content/en-us/reference/cloud/datastores-api/v1.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"openapi": "3.0.1",
33
"info": {
4-
"title": "Standard Data Stores",
5-
"description": "This page includes reference documentation for working with standard data stores. For more information on using the API, see [Handling API Requests for Data Stores](../../../cloud/open-cloud/data-store-api-handling.md) and the [Usage Guide](../../../cloud/open-cloud/usage-data-stores.md).",
4+
"title": "Standard data stores",
5+
"description": "This page includes reference documentation for working with standard data stores. For more information on using the API, see [Handle API requests for data stores](../../../cloud/open-cloud/data-store-api-handling.md) and the [usage guide](../../../cloud/open-cloud/usage-data-stores.md).",
66
"version": "v1"
77
},
88
"servers": [

content/en-us/reference/cloud/messaging-service/v1.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
"tags": ["CrossServerMessaging"],
1717
"operationId": "CrossServerMessaging_Publish",
1818
"x-roblox-cloud-api-operation-name": "Publish a Message",
19-
"description": "Publish a message to a pre-defined topic of an experience, with the size of the message up to 1,024 characters (1 KB). Requires the **Publish** permission for API keys and the **universe-messaging-service:publish** scope for OAuth 2.0 apps. See [Cross-Server Messaging](../../../cloud-services/cross-server-messaging.md#subscribe-users-to-receive-messages) for defining and subscribing users to a topic.",
19+
"description": "Publish a message to a pre-defined topic of an experience, with the size of the message up to 1,024 characters (1 KB). Requires the **Publish** permission for API keys and the **universe-messaging-service:publish** scope for OAuth 2.0 apps. See [Cross-server messaging](../../../cloud-services/cross-server-messaging.md#subscribe-users-to-receive-messages) for defining and subscribing users to a topic.",
2020
"parameters": [
2121
{
2222
"name": "universeId",

content/en-us/reference/cloud/universes-api/v1.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"openapi": "3.0.1",
33
"info": {
44
"title": "Place Publishing",
5-
"description": "You can send and receive the following request and response payloads to publish and update your places on Roblox. For information on the usage of the API, see the [Usage Guide](../../../cloud/open-cloud/usage-place-publishing.md).",
5+
"description": "You can send and receive the following request and response payloads to publish and update your places on Roblox. For information on the usage of the API, see the [usage guide](../../../cloud/open-cloud/usage-place-publishing.md).",
66
"version": "v1"
77
},
88
"servers": [
@@ -32,7 +32,7 @@
3232
"name": "placeId",
3333
"in": "path",
3434
"required": true,
35-
"description": "The identifier of your place. See [Publishing Places with API Keys](../../../cloud/open-cloud/usage-place-publishing.md) on obtaining a Place ID.",
35+
"description": "The identifier of your place. See [Publishing places with API keys](../../../cloud/open-cloud/usage-place-publishing.md) on obtaining a Place ID.",
3636
"schema": {
3737
"type": "integer",
3838
"format": "int64"

content/en-us/reference/engine/classes/Player.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2506,6 +2506,8 @@ events:
25062506
`Class.CharacterMesh|CharacterMeshes`. This event will fire when all such
25072507
objects have been inserted into the `Class.Player.Character`.
25082508
2509+
This event only fires on the server.
2510+
25092511
One use for this event is to ensure all accessories have loaded before
25102512
destroying them. See below for an example of this.
25112513
code_samples:

0 commit comments

Comments
 (0)