- Looking for ideas? Check out "good first PR" label.
- Or start a conversation in Issues to get help and advice from the community on PR ideas.
- Read the writing standards below.
- Keep PRs simple and focused - one PR per feature with a screenshot of the changes on the site. Example PR.
- Make a Pull Request.
- Complete the Contributor License Agreement.
- Happy Days! 🎉
Feel free to contribute documentation fixes and new tutorials as a pull request.
If you are looking for ideas what to work on, head to Issues and check out open tickets or start a conversation. It is best to start conversation if you are going to create a larger tutorial or refactor a section of the user manual. The Forum is good place to have a chat with the community as well.
Try to keep your PR focused on a single subject or tutorial. Small PRs are easier to review and will get merged faster.
Keep your target audience in mind and assume that they are completely new to the subject or PlayCanvas. Refer them to other pages or tutorials if you need prior knowledge to better understand the current content. For example, an FPS tutorial can refer to Basic Keyboard and Mouse Input as tutorials to complete before continuing.
Avoid using acronyms unless they are already defined on the page.
For example, use "Initialize" instead of "Initialise", and "color" instead of "colour".
Each page on developer.playcanvas.com is generated from a Markdown file in docs.
The content layout for the User Manual mirrors the folder layout in docs/user-manual.
Tutorials are grouped by tags that are listed at the top of each tutorial page in the metadata. The list of tags can be found on the left of our tutorials page.
Use reference style links (except for images) and minimize the use of HTML as much as possible. HTML usage is limited to:
<iframe>for PlayCanvas project builds<img>to adjust sizes of images- alert style boxes
For <iframe> and <img>, use loading="lazy" attribute to reduce initial page load times and size.
Refer to existing pages to see examples of prior use.
Images should be placed in the static/img folder. The folder structure should mirror the same structure as the folder for the Markdown files mentioned in the Pages section.
Please use PNG for anything Editor UI based and JPEG for anything else such as a game screenshot.
Use WebP for animated images (the site is moving away from Animated GIFs due to their poor compression and quality).
All images should be less than 2MB ideally.
When inserting code into a Markdown file, use backticks. For example:
```javascript
console.log('Hello World!);
```Be sure to specify the relevant language to enable syntax highlighting. Valid values are: css, glsl, html, javascript, json, sh and typescript. Use none to disable syntax highlighting.
For any JavaScript code, please refer to the PlayCanvas style guide.
When writing a link in a Markdown file use either of the following formats but please do not to mix the formats on the same page:
[link text][1]
[1]: https://example.comOr
[link text][example-page]
[example-page]: https://example.comThe only exception is writing FAQ Markdown files (located in the faq folder). For those, use the \[link text\](url) format.
Other files such as assets and zips can be placed in downloads. As this is used very rarely, there is no folder structure to maintain.
Usually, tutorials require a PlayCanvas project. Please transfer ownership of any related projects to user playcanvas. Steps to transfer projects can be found here in the documentation.