ArkScript-lang / ArkScript-lang/Ark

Add an ArkScript tutor in the CLI

オープン
#711 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る
🤔 help wanted ark/repl documentation enhancement
主要言語
C++
スター
728
フォーク
54
平均マージ
4時間 8分
マージ済み PR(30日)
2

説明

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.

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

調査の方向性

まず、既存のCLIヘルプ、REPL、ウェブサイトのリソース、言語チュートリアルを読んで、エントリーポイントとチュートリアルの内容がどのように構成されているかを理解します。tutorの章、実行可能な例、よくあるエラーの説明、CLIの起動パスを定義します。オフラインで動作し、CLIヘルプとウェブサイトの両方から参照されれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
cpp
領域
cli, documentation
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
活発
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。