[Doc] Introduction
Nobody has claimed this yet.
- Dominant language
- Lua
- Stars
- 613
- Forks
- 45
- PR merge metrics
- No merged PRs in 30d
Description
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
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the documentation under doc/docs/doc, especially the “An Overview of YueScript” section linked in the issue. Review how object literals, the * symbol, pipes, imports, and macros are currently introduced; done means these basics are explained and the introductory material follows a beginner-friendly order.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100