alexa-games / litexa

Language and toolchain for writing Alexa skills.
https://litexa.com
Apache License 2.0
37 stars 7 forks source link

Documentation Feature: Audit the Language Reference #156

Open cheruvian opened 4 years ago

cheruvian commented 4 years ago

Feature Request

Audit the Language Reference and (re)move anything that is not a the language syntax level of abstraction.

Current Behavior

The current Language Reference includes several levels of Language abstraction all at one level. This can make it difficult to understand what is valid syntax where.

One example is including Utterance in the language reference. An Utterance is not actually part of the Litexa Language, similar to how VariableName is not part of the JavaScript language. Rather Utterance is a string parameter of the when statement (similar to how VariableName is a parameter of the let/var/const statement)

Desired Behavior

IMO the Language Reference (or a new separate page) should only be a Language Syntax Reference that included only the syntactically relevant language components and had the parameters as sub items within the syntax section (not against using the MDN pages as a prototype)

cheruvian commented 4 years ago

Perhaps a good time to separate out the test syntax from the "main" syntax as well, unless there's a compelling reason to keep them together.