rhaiscript / rhaiscript/book

Add a FAQ page

Open
#23 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
32
Forks
28
PR merge metrics
No merged PRs in 30d

Description

Having a FAQ page makes it easy for people to answer their common Rhai why's. The structure should at least partially replicate that of the Python FAQ.

An example question for the design section could look like this:

Why does Rhai require semicolons?

You probably can expect us to not enforce semicolons at the end of every statement, but the Rhai designer decided not to for two reasons:

  1. To prevent scripts from breaking when you omitted a semicolon between two statements that would otherwise be one statement. Rhai wouldn't be alone in this regard because of JavaScript, which has a mechanism called ASI that is only designed to insert semicolons where they are normally required. That's why several style guides, such as Airbnb's one, enforce semicolons.
  2. No consensus on ASI or on Ruby-like handling. Neither way is simple enough to be implemented in Rhai's handwritten lexer.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the existing Rhai Book structure and the linked Python FAQ first to understand how a FAQ page could fit. Add a FAQ page with a structure that partially follows the Python reference and include questions such as the semicolon design example; done means the page is integrated into the book and its content is readable and useful.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.