playcanvas / playcanvas/developer-site

Detail how projects are built when published and launched

Open
#172 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
146
Forks
72
Avg merge
1d 2h
Merged PRs (30d)
33

Description

Users tend to overestimate the ‘magic’ in PlayCanvas of making projects and not realise how the files are packages and literally just added to the page as a script DOM.

Explaining this in detail can help some developers to debug their own issues and understand why script order matters.

  • Show how an application is packaged by PlayCanvas publish steps
  • Detail how the boiler plate code for PlayCanvas apps is done

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the PlayCanvas publish steps and the boilerplate code for PlayCanvas applications. Document how publishing packages the application, how the files are added to the page as script DOM elements, and why script order matters. Done when both checklist items are explained clearly enough to help developers debug their own projects.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.