Skip to content

Latest commit

 

History

History
105 lines (65 loc) · 7.62 KB

README.md

File metadata and controls

105 lines (65 loc) · 7.62 KB
Raw

Roblox Creator Documentation

This repository holds source code for the creator documentation at create.roblox.com/docs.

Note: Currently, the repository has guides, tutorials, educational content, and the Engine API reference. Code samples are coming soon.

If you're unfamiliar with the GitHub contribution process, see About pull requests and the following video.

contributing-to-creator-docs-on-github.mp4

Reporting Issues

If you find a problem with the documentation and don't want to submit a pull request, please let us know by reporting it on the Roblox developer forums.

Contribution Guidelines

Any addition to the Roblox creator documentation has to fit within the larger whole. In other words, even a comprehensive, accurate, well-written blog post or technical whitepaper might not have a home on the website.

Generally speaking, we look for content that conforms to our existing standards and applies to a wide variety of experiences and use cases. For example, we prefer pages like Building User Interfaces to pages like Creating a Speedometer for a Racing Game. Consider posting more specialized guides to the Roblox developer forum.

When you submit a pull request for review, you must agree to the following:

  • This contribution was created in whole or in part by me, and I have the right to submit it under the terms of this repository's open source licenses.
  • I understand and agree that this contribution and a record of it are public, maintained indefinitely, and may be redistributed under the terms of this repository's open source licenses.
  • To the best of my knowledge, all proposed changes are accurate.

Minor Contributions

For simple changes that only touch a single file, use GitHub's web-based editor:

  1. Find the file in content/en-us/ and click Edit this file.
  2. Click Fork this repository.
  3. Make your changes and click Commit changes....
  4. Give your change a descriptive commit message and click Propose changes.
  5. Ensure that the base repository is Roblox/creator-docs and the base branch is main. Verify that you're happy with your changes and click Create pull request.
  6. Finally, fill out the details in the pull request description and click Create pull request.

Larger Contributions

For larger changes that touch multiple files, we recommend github.dev, a more full-featured text editor based on Visual Studio Code that runs in your browser:

  1. Fork the repository.
  2. While browsing your fork, press the . key to open github.dev.
  3. In the Source Control menu, click ... > Branch > Create Branch....
  4. Give the branch a name and click Switch to Branch.
  5. Use the Explorer menu to find the files you want to update in content/en-us, and make your desired changes.
  6. In the Source Control menu, verify that you're happy with your changes.
  7. Add a commit message and click Commit & Push.
  8. In a new browser tab, navigate to github.com/Roblox/creator-docs.
  9. Click Compare & pull request.
  10. Verify that the base repository is Roblox/creator-docs and the base branch is main. The head repository should be your fork and your branch.
  11. Finally, fill out the details in the pull request description and click Create pull request.

Alternatively, you can use the GitHub or GitHub Pull Request menus in github.dev to submit the pull request. For documentation on using github.dev, see GitHub Codespaces.

Offline Workflow

This repository is extremely large, so we recommend using the online options whenever possible. However, if you're already familiar with the general GitHub workflow and want to use an offline text editor, here are the basic steps for contributing to the documentation:

  1. Set up Git and Git LFS. Alternatively, install a Git client like GitHub Desktop.
  2. Fork this repository.
  3. Clone your fork.
  4. Navigate to the repository root.
  5. Create a new branch.
  6. Make your desired changes.
  7. Commit, push to your fork, and submit your pull request against this repository's main branch.

For more detailed steps, see CONTRIBUTING.md.

Document Types

The Roblox documentation has three main document types:

  • Conceptual and task-based guides in .md files in content/en-us/

    Guides teach you about a feature or workflow without being overly prescriptive about the end result. They introduce concepts and features and cover the tasks you can accomplish using various tools or other approaches.

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

  • API reference docs in .yaml files in content/en-us/reference

    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.

  • Tutorials in .md files in content/en-us/tutorials

    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.

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.

Contribution Basics

Try to limit your edits to one class or feature so that the pull request is easier to review. Bug fixes and smaller improvements have a higher likelihood of fast approval. Large guides often require significant back-and-forth before publication.

To avoid formatting issues, we recommend text editors like github.dev that let you preview Markdown as you write it. For prose, try to follow the guidelines in STYLE.md. For code samples, use the Lua Style Guide.

To view a page fully formatted per what we see on the main branch, replace the entire URL from content/ and before. Files with the basename index should have that name removed. For example, the page for "https://github.com/Roblox/creator-docs/blob/main/content/en-us/avatar/index.md" is rendered at "https://create.roblox.com/docs/en-us/avatar".

Licenses

  • For prose, this project uses the Creative Commons Attribution 4.0 International Public License. For full license text, see LICENSE.
  • Code samples are available under the MIT License. For full license text, see LICENSE-CODE.

Code of Conduct

To maintain an open, welcoming, diverse, inclusive, and healthy community, this project enforces an adapted version of the Contributor Covenant. For more information, see CODE_OF_CONDUCT.md.