Add an ArkScript tutor in the CLI

Open
#711 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

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.

Description

🤔 help wanted ark/repl documentation enhancement

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.

Dominant language
C++
Stars
729
Forks
54
Avg merge
4h 8m
Merged PRs (30d)
2

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.

More from ArkScript-lang/Ark

All issues in ArkScript-lang/Ark

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.