Interested in helping improve the new user documentation?

[Kamran Ayub]

Hi all!

If you've been using Excalibur, you probably know most documentation is within the "API reference" docs, built from source. Well, we had spent some time in the past making more friendlier documentation but it's still locked within that API reference site.

New Home for Usage Documentation

I'm super excited to share we're getting ready to merge some better user docs that will be hosted directly within the "Docs" area of the site!

You can preview the new docs at: https://excaliburjs-preview.netlify.app/docs/engine

Help Polish the Docs

These docs are still out-of-date in places, symbol (code) links are missing/broken, and examples are outdated. I am personally working on polishing but if you want to help, please add reviews/suggestions/fixes on the PR:

https://github.com/excaliburjs/excaliburjs.github.io/pull/29

Hope you enjoy the new docs soon!

Cheers,

Excalibur.js team

[DaVince]

Wow, there's a lot of documentation here! This should makes things a lot easier for new users quite a lot. Glad to see the documentation can be contributed to through good old Github as well. :)

I'm definitely going to give this a thorough look-through after work and leave a bunch of feedback and contributions!