[Doc] Introduction

[ShalokShalom]

Hi there :)

As of now, there is no proper explaination to the initial code example in the docs.

https://github.com/IppClub/YueScript/tree/main/doc/docs/doc#an-overview-of-yuescript

Looking up 'object literals' in the docs, (with ctrl+f) yields no results.

I suggest to add the following text:

In Yuescript, object literals are a syntax for defining Lua tables (objects/dictionaries) with a more expressive and concise style. The * symbol is used to denote list elements or multiple entries within a table.

Also the pipes are not explained at all.

I didn't send a PR, since I wanted to ask permission, to rearrange the docs a bit too, before I do.

Now, a lot of the very basic stuff, like importing, is fairly far down, while arguably one of the most difficult features is very much on the top.

A beginner should start with imports, and not macros ;)

Do you agree, then I send you a PR

[pigpigyyy]

Thank you so much for your thoughtful feedback and suggestions!

To be honest, I haven't been able to give the documentation the attention it deserves lately, so I'd genuinely welcome and appreciate your help in improving it and then merge any PR made by you.

[SkyyySi]

AFAIK this is called an "implicit table", rather than an "object literal". The formert makes a lot more sense, because that's exactly what it does: create a table without explicitly adding braces {} around it. "Object literal" would just be confusing, because

1. there is no "object" language construct in Lua or YueScript like there is in JavaScript - it's all tables
2. the regular table syntax with braces is also a literal

[ShalokShalom]

Yeah, I had to google around and use the AI, to find what that meant.

"Oh, that's just tables" 🤷🏻‍♂️