How To add a New Reference Example

Adding a new example to Wick Editor's reference is a good way to explain Wick Editor coding and animation concepts. The following steps must be followed when adding a new reference item.

1. Pitch the example in an issue

Community members looking to add an example or new reference item should pitch this idea in a GitHub issue. Create a new issue using the "Documentation Request" option and describe what you'd like added.

2. Create an example project

Once approved, create an example project. This example should be as simple as possible to get the point of the documentation.

3. Add example project to the editor repository.

Add the example to the editor repository. It should be added in the public/examples folder. Title the example reference-exampleName.wick.

4. Add example to the web reference.

Add the example to the wick-site repository. It should be added to the public/examples folder. Title the example reference-exampleName.wick.