Skip to content

Commit 8c68f26

Browse files
update Open Source Docs from Roblox internal teams
1 parent 2a1e4aa commit 8c68f26

File tree

9 files changed

+329
-23
lines changed

9 files changed

+329
-23
lines changed

.vscode/markdown.code-snippets

Lines changed: 173 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,5 +49,178 @@
4949
"</Tabs>"
5050
],
5151
"scope": "markdown"
52+
},
53+
"Markdown Alert": {
54+
"prefix": ["rbx:alert"],
55+
"description": "Alert component for warnings, info, success, error",
56+
"body": [
57+
"<Alert severity='${1|info,warning,error,success|}'>",
58+
"${0}",
59+
"</Alert>"
60+
],
61+
"scope": "markdown"
62+
},
63+
"Markdown Grid Container": {
64+
"prefix": ["rbx:grid-container"],
65+
"description": "Grid container for layout",
66+
"body": [
67+
"<GridContainer numColumns='${1:2}'>",
68+
"\t${0}",
69+
"</GridContainer>"
70+
],
71+
"scope": "markdown"
72+
},
73+
"Markdown Grid": {
74+
"prefix": ["rbx:grid"],
75+
"description": "Grid component with items",
76+
"body": [
77+
"<Grid container spacing={${1:2}} style={{marginBottom: ${2:24}}}>",
78+
"\t<Grid item container XSmall={12} Medium={6} Large={4} direction='row' style={{gap: ${3:24}, marginBottom: ${4:12}}}>",
79+
"\t\t<Grid item container wrap='nowrap' direction='column' style={{gap: ${5:8}, flex: 1}}>",
80+
"\t\t\t${0}",
81+
"\t\t</Grid>",
82+
"\t</Grid>",
83+
"</Grid>"
84+
],
85+
"scope": "markdown"
86+
},
87+
"Markdown Typography": {
88+
"prefix": ["rbx:typography"],
89+
"description": "Typography component",
90+
"body": [
91+
"<Typography variant='${1|h1,h2,h3,h4,h5,h6,body1,body2,subtitle1,subtitle2|}'>${0}</Typography>"
92+
],
93+
"scope": "markdown"
94+
},
95+
"Markdown Figure": {
96+
"prefix": ["rbx:figure"],
97+
"description": "Figure with image and caption",
98+
"body": [
99+
"<figure>",
100+
"\t<img src='${1:../assets/path/to/image.png}' alt='${2:Alt text}' />",
101+
"\t<figcaption>${3:Caption text}</figcaption>",
102+
"</figure>"
103+
],
104+
"scope": "markdown"
105+
},
106+
"Markdown Image": {
107+
"prefix": ["rbx:img"],
108+
"description": "Image with common attributes",
109+
"body": [
110+
"<img src='${1:../assets/path/to/image.png}' alt='${2:Alt text}' width='${3:50%}' />"
111+
],
112+
"scope": "markdown"
113+
},
114+
"Markdown YouTube Iframe": {
115+
"prefix": ["rbx:youtube"],
116+
"description": "YouTube video iframe",
117+
"body": [
118+
"<iframe width='${1:800}' height='${2:450}' src='https://www.youtube-nocookie.com/embed/${3:VIDEO_ID}' title='YouTube video player' frameborder='0' allow='accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share' allowfullscreen></iframe>"
119+
],
120+
"scope": "markdown"
121+
},
122+
"Markdown Lua Code Block": {
123+
"prefix": ["rbx:lua"],
124+
"description": "Lua code block",
125+
"body": [
126+
"```lua",
127+
"${0}",
128+
"```"
129+
],
130+
"scope": "markdown"
131+
},
132+
"Markdown Lua Code Block with Highlight": {
133+
"prefix": ["rbx:lua-highlight"],
134+
"description": "Lua code block with line highlighting",
135+
"body": [
136+
"```lua highlight='${1:2}'",
137+
"${0}",
138+
"```"
139+
],
140+
"scope": "markdown"
141+
},
142+
"Markdown Table": {
143+
"prefix": ["rbx:table"],
144+
"description": "HTML table structure",
145+
"body": [
146+
"<table>",
147+
"<thead>",
148+
"\t<tr>",
149+
"\t\t<th>${1:Header 1}</th>",
150+
"\t\t<th>${2:Header 2}</th>",
151+
"\t</tr>",
152+
"</thead>",
153+
"<tbody>",
154+
"\t<tr>",
155+
"\t\t<td>${3:Cell 1}</td>",
156+
"\t\t<td>${4:Cell 2}</td>",
157+
"\t</tr>",
158+
"</tbody>",
159+
"</table>"
160+
],
161+
"scope": "markdown"
162+
},
163+
"Markdown Frontmatter": {
164+
"prefix": ["rbx:frontmatter"],
165+
"description": "YAML frontmatter for markdown files",
166+
"body": [
167+
"---",
168+
"title: ${1:Page Title}",
169+
"description: ${2:Page description}",
170+
"---",
171+
"",
172+
"${0}"
173+
],
174+
"scope": "markdown"
175+
},
176+
"Markdown Blockquote": {
177+
"prefix": ["rbx:blockquote"],
178+
"description": "Blockquote element",
179+
"body": [
180+
"<blockquote>",
181+
"${0}",
182+
"</blockquote>"
183+
],
184+
"scope": "markdown"
185+
},
186+
"Markdown Code Inline": {
187+
"prefix": ["rbx:code"],
188+
"description": "Inline code with backticks",
189+
"body": [
190+
"`${0}`"
191+
],
192+
"scope": "markdown"
193+
},
194+
"Markdown Link": {
195+
"prefix": ["rbx:link"],
196+
"description": "Markdown link",
197+
"body": [
198+
"[${1:Link Text}](${2:../path/to/page.md})"
199+
],
200+
"scope": "markdown"
201+
},
202+
"Markdown Class Reference": {
203+
"prefix": ["rbx:class"],
204+
"description": "Class reference link",
205+
"body": [
206+
"`Class.${1:ClassName}`"
207+
],
208+
"scope": "markdown"
209+
},
210+
"Markdown Property Reference": {
211+
"prefix": ["rbx:property"],
212+
"description": "Property reference link",
213+
"body": [
214+
"`Class.${1:ClassName}.${2:PropertyName}`"
215+
],
216+
"scope": "markdown"
217+
},
218+
"Markdown Method Reference": {
219+
"prefix": ["rbx:method"],
220+
"description": "Method reference link",
221+
"body": [
222+
"`Class.${1:ClassName}:${2:MethodName}()`"
223+
],
224+
"scope": "markdown"
52225
}
53226
}
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
version https://git-lfs.github.com/spec/v1
2-
oid sha256:f5c52bb6e4872aab80b06987a7dfd39f4d7e95af1185a06af7cb755fee6c8146
3-
size 32802625
2+
oid sha256:3022b5bfad8676b5d3372a343301016ce2c7015bcbbae94f72d8a03f03aa2e34
3+
size 32801865

content/en-us/cloud/auth/api-keys.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,9 @@ To create an API key:
4141
</Alert>
4242

4343
1. If applicable, select the experience that you want to access with the API key.
44+
45+
For user-owned API keys, you have the option to disable **Restrict by Experience**. When disabled, your API key has access to all of your user-owned experiences and any group-owned experiences that you have the correct permissions for, including experiences created in the future.
46+
4447
1. From the **Select Operations** dropdown, select the operations that you
4548
want to enable for the API key.
4649

@@ -52,7 +55,7 @@ To create an API key:
5255
For security reasons, give each API key the minimum number of required permissions. If an API key leaks, this principle of least privilege ensures that only a subset of your resources are compromised.
5356
</Alert>
5457

55-
1. (Optional) In the **Security** section, explicitly restrict IP access to the key using [CIDR
58+
1. **(Optional)** In the **Security** section, explicitly restrict IP access to the key using [CIDR
5659
notation](#cidr-format). You can find
5760
the IP address of your local machine and add it to the **Accepted IP
5861
Addresses** section along with additional IP addresses for those that need

content/en-us/cloud/guides/usage-assets.md

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,24 @@ Updating asset metadata using the **Update Asset** endpoint is not subject to th
3333
</tr>
3434
</thead>
3535
<tbody>
36+
<tr>
37+
<td><a href="../../animation/index.md">Animation</a></td>
38+
<td>
39+
<ul>
40+
<li>`.rbxm`</li>
41+
</ul>
42+
</td>
43+
<td>
44+
<ul>
45+
<li>`model/x-rbxm`</li>
46+
</ul>
47+
</td>
48+
<td>
49+
<ul>
50+
<li>`.rbxm` files edited outside of [Roblox Studio](../../studio/setup.md) might not upload or function.</li>
51+
</ul>
52+
</td>
53+
</tr>
3654
<tr>
3755
<td><a href="../../audio/assets.md">Audio</a></td>
3856
<td>
@@ -99,7 +117,7 @@ Updating asset metadata using the **Update Asset** endpoint is not subject to th
99117
</td>
100118
<td>
101119
<ul>
102-
<li>Only content downloaded from [Asset Delivery API](../../cloud/api/asset-delivery.md) is accepted. If you are not trying to export and re-import meshes, then use [3D Importer](../../art/modeling/3d-importer.md) to import meshes instead.</li>
120+
<li>Only content downloaded from [Asset Delivery API](../../cloud/api/asset-delivery.md) is accepted. If you are not trying to download and re-upload meshes, then use [3D Importer](../../art/modeling/3d-importer.md) to import meshes instead.</li>
103121
<li>Not available for updating.</li>
104122
</ul>
105123
</td>
@@ -109,21 +127,27 @@ Updating asset metadata using the **Update Asset** endpoint is not subject to th
109127
<td>
110128
<ul>
111129
<li>`.fbx`</li>
130+
<li>`.gltf`</li>
131+
<li>`.glb`</li>
132+
<li>`.rbxm`</li>
112133
</ul>
113134
</td>
114135
<td>
115136
<ul>
116137
<li>`model/fbx`</li>
138+
<li>`model/gltf+json`</li>
139+
<li>`model/gltf-binary`</li>
140+
<li>`model/x-rbxm`</li>
117141
</ul>
118142
</td>
119143
<td>
120144
<ul>
121-
<li>Imports custom 3D models (`.fbx`) as a `Class.Model` container containing one or more `Class.MeshPart` objects.</li>
145+
<li>Imports custom 3D models as a `Class.Model` container containing one or more `Class.MeshPart` objects.</li>
122146
<ul>
123147
<li>Depending on your use-case, consider uploading custom 3D models manually using the [3D Importer](../../art/modeling/3d-importer.md).</li>
124148
<li>The 3D Importer provides a 3D preview, various error-checking, and many customizable import settings.</li>
125149
</ul>
126-
<li>Does not support Roblox `.rbxm` formats</li>
150+
<li>`.rbxm` files edited outside of [Roblox Studio](../../studio/setup.md) might not upload or function.</li>
127151
</ul>
128152
</td>
129153
</tr>

content/en-us/ip-licensing/creators.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,13 @@ We recommend that you include the following information in your pitch:
7171

7272
- What the current state of your experience is and when you expect the IP to be fully integrated into your experience.
7373

74-
Your pitch should **not** include foul or harmful language, negotiation intent, request for financial information, or request to connect with the IP holder outside of Roblox.
74+
Your pitch must **not** include any of the following:
75+
76+
- Attempts to negotiate or discuss terms
77+
- Requests for financial of personal information
78+
- Foul or harmful language
79+
- Legal or threatening language that could be considered harassing for a 13+ audience
80+
- Requests to connect with the IP holder outside of Roblox
7581

7682
## View license agreements
7783

content/en-us/makeup/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ Makeup is currently in beta and is not yet available for sale or implementation
2222
Makeup is made up of multiple textures baked into a `Class.Decal` that you can apply to a face of a character. There are three primary regions of the face (eyes, lips, face/cheeks) that you can apply textures to. Each region has some overlapping surfaces with other regions.
2323

2424
<GridContainer numColumns="3">
25-
<figure><img src="../assets/makeup/Makeup-Eye-Section.png" /><figcaption>Eye region<sup>&dagger;</sup></figcaption></figure>
26-
<figure><img src="../assets/makeup/Makeup-Mouth-Section.png" /><figcaption>Lips region<sup>&dagger;</sup></figcaption></figure>
25+
<figure><img src="../assets/makeup/Makeup-Eye-Section.png" /><figcaption>Eye region</figcaption></figure>
26+
<figure><img src="../assets/makeup/Makeup-Mouth-Section.png" /><figcaption>Lips region</figcaption></figure>
2727
<figure><img src="../assets/makeup/Makeup-Face-Section.png" /><figcaption>Face/cheek region</figcaption></figure>
2828
</GridContainer>
2929

0 commit comments

Comments
 (0)