Skip to content

Commit fc93cca

Browse files
authored
Merge branch 'main' into patch-2
2 parents 3b964b6 + c91e1cf commit fc93cca

File tree

513 files changed

+222
-5510
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

513 files changed

+222
-5510
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/common/navigation/engine/guides.yaml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,6 @@ navigation:
3838
path: /projects/experience-ownership-transfer
3939
- title: Place files
4040
path: /projects/place-files
41-
- title: Transfer animations
42-
path: /projects/transfer-animations
4341
- title: Work in teams
4442
path: /projects/groups
4543
section:
Lines changed: 2 additions & 2 deletions
Loading
Lines changed: 3 additions & 0 deletions
Loading
Lines changed: 3 additions & 0 deletions
Loading
Lines changed: 3 additions & 0 deletions
Loading
Lines changed: 3 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)