Skip to content

Commit 6eb7186

Browse files
update Open Source Docs from Roblox internal teams
1 parent d04c878 commit 6eb7186

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This repository holds source code for the creator documentation at [create.roblox.com/docs](https://create.roblox.com/docs).
44

5-
**Note**: Currently, the repository has guides, tutorials, educational content, and the Engine API reference. Code samples are coming soon.
5+
**Note**: Currently, the repository has guides, tutorials, educational content, and a read-only version of the Engine API reference.
66

77
If you're unfamiliar with the GitHub contribution process, see [About pull requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) and the following video.
88

@@ -77,14 +77,14 @@ The Roblox documentation has three main document types:
7777

7878
Guides benefit massively from practical, real-world use cases, images, code snippets, and diagrams. Most task-based content should include a numbered list.
7979

80-
- API reference docs in `.yaml` files in [content/en-us/reference](./content/en-us/reference)
81-
82-
APIs are entirely reference content and should use functional descriptions, linking to guides where appropriate. More than other content types, reference content should be terse and direct; summaries for properties, methods, events, and callbacks don't need to be full sentences.
83-
8480
- Tutorials in `.md` files in [content/en-us/tutorials](./content/en-us/tutorials)
8581

8682
Compared to task-based guides, tutorials are more self-contained and take you from _nothing_ to _something_. This focus on creating something specific means they're typically much more prescriptive than guides. Tutorials often touch multiple features and concepts at the same time, demonstrating the connections between tools and strategies.
8783

84+
- API reference docs in `.yaml` files in [content/en-us/reference](./content/en-us/reference)
85+
86+
We provide these files so that you can view the source and use them in your own projects, but we **no longer** accept pull requests on the reference `.yaml` files.
87+
8888
If your contribution doesn't fit within these categories or covers a particularly narrow subject, it might not be a good fit for the documentation. Consider posting it to the [Roblox developer forum](https://devforum.roblox.com/c/resources/71).
8989

9090
## Contribution Basics

content/en-us/effects/particle-emitters.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,7 @@ Note that changing `Class.ParticleEmitter.Speed|Speed` does not affect active pa
204204

205205
### Rate
206206

207-
The `Class.ParticleEmitter.Rate|Rate` property sets the number of particles that emit per second. A single particle emitter can create up to 500 particles per second. For best performance, keep the particle rate as low as possible and experiment with [size](#size) and [other properties](#other-properties) to achieve the desired visual effect.
207+
The `Class.ParticleEmitter.Rate|Rate` property sets the number of particles that emit per second. A single particle emitter can create up to 400 particles per second (100 per second on mobile). For best performance, keep the particle rate as low as possible and experiment with [size](#size) and [other properties](#other-properties) to achieve the desired visual effect.
208208

209209
<Alert severity="warning">
210210
Particle count can impact performance due to overdraw, especially when particles are overlapping. The more layers of transparent effects on screen, the more costly it is on the GPU.

0 commit comments

Comments
 (0)