ArkScript-lang / ArkScript-lang/Ark

Add an ArkScript tutor in the CLI

Open
#711 0 comments 0 reactions 0 assignees View on GitHub
🤔 help wanted ark/repl documentation enhancement
Dominant language
C++
Stars
728
Forks
54
Avg merge
4h 8m
Merged PRs (30d)
2

Description

ArkScript has documentation, a tutorial and resources on a multitude of subjects on it website, but you need an internet connection to access them, and to switch to your REPL or the online playground to try things out.

It would be nice to have an ArkScript tutor, like vim or helix, that could be launched from the CLI, eg using the REPL?

It should be referenced in the help message of the cli, and on the website.

I'd like to see something with chapters, like the language tutorial we have, where you can try some code and see what it does, with the tutor explaining common errors.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reading the existing CLI help, REPL, website resources, and language tutorial to understand how entry points and tutorial content are organized. Define the tutor's chapters, runnable examples, common-error explanations, and CLI launch path; it is done when it works offline and is referenced in both CLI help and the website.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
cli, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.