[Suggestion] Documentation and getting started tutorial

[why-try313]

As mentioned in #24 , I'm creating a Wiki with, so far, all my knowledge about using this version of godot, trying to hopefully provide a starter guide and reduce the amount of tickets here related to the use of Godot and keep these issues for builds and C++ suggestions/issues

Feel free use, open issues there related to the use of Godot ECMAScript as you'd do here, or provide suggestions.

Godot ECMAScript Manual Link: https://github.com/why-try313/godot-ECMAScript-cookbook/wiki

Table of contents:

• [x] Using Godot ECMAScript module
  Creating scripts, _ready, _process, variables, get_node and other basic methods to get started
• [x] Creating elements
  How to use the new constructor and how to find Godot's elements
• [x] Property variables and hints
  Exporting variables and setting hints to use in the editor
• [x] Signals
  Exporting and using signals through scripts and the editor
• [x] Importing modules
  require and import differences
• [x] Tooled scripts
  Using the @tool magic key
• [x] Singletons
  Create and use a singleton
• [x] Q&A
  Avoid getting stuck searching for hours how to solve a simple problem

Mentions: @Geequlim , @fire

[nmerget]

Hey @why-try313, first of all, thank you very much, it was very helpful as a starting point. 👍

I would like to add better documentation as well to host on gh-page. I think this would be great inside this repo. If you allow I would use your wiki to create the first docs folder.

The advantage of this would be that everyone could add/update the files with a fork and we could show the documentation for multiple versions.

[why-try313]

Hi @nmerget, the whole point of this wiki is to keep it simple, an introduction should guide and be simple and short enough to ecourage the reader to try it. Just know it's already translated in spanish and french but for the sole purpose of simplicity I dropped this idea to keep it simple and straight to the point. Right now the wiki is stagnant because I'm waiting for the version 4.x, as soon as it's realeased the repo will be updated, which means it will evolve, which means that you'll have outdated content (and before you ask me, no I'm not willing to use gh-pages).

If you're ok with that sure, you can use and quote my content, what I'm thinking though it's to link your content at the end of mine, an introduction that leads to more complex or "better documentation" as you say since my repo is not really documentation but more a tutorial

PS: that's why issues are open on my repo, this conversation could've been moved to keep this page to ECMAScript GD4 builds

[nmerget]

Okay understood :)

I will use your guide as an inspiration for how the documentation could be structured.

Moreover, it's a great idea to have a Tutorial/Examples list right at the start to get some additional resources. And there I would link your wiki.

[why-try313]

@nmerget Be sure to tag me whenever your docs are ready so I can include them in the README.md and the wiki

[nmerget]

@Geequlim can you activate github pages in the settings? There is already the gh-pages branch so it should be straight forwarded.

[Geequlim]

@nmerget I enabled the github pages. Thanks for your great work !

[Geequlim]

The documentation site is up at https://geequlim.github.io/ECMAScript/ now

[why-try313]

Bump to notify Github-pages link is set on the cookbook readme and wiki as 🏷️ alpha, version will change according to the gh-pages changes