Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

docs: organize docs/ by audience (guide / reference / explanation / internals) and add a real tutorial

オープン 初心者向け
  • 何か問題がありますか？
#1,270 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜2日
初心者へのやさしさ
70/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
c, markdown
領域
documentation

調査の方向性

まず既存の docs/ ディレクトリを読み、現在のフラットな構造を理解します。issue の分類に基づいて、どのファイルがガイド、リファレンス、解説、内部詳細に属するかを特定します。新しいサブディレクトリを作成し、それに応じてファイルを移動し、index.md や他のドキュメント内のリンクを更新します。docs-claims PATHS クラスと Pages ビルドが壊れたリンクなしでパスすることを確認します。最後に、実行可能な例を含む簡単なチュートリアルを docs/guide/ に作成します。

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

説明

area:docs help wanted kind:decision

Problem. docs/ is 30 files in one flat directory, with no signal of audience.

  • Reference: SPEC, GRAMMAR, BUILTINS, STDLIB.
  • Explanation: OBSERVER, ARCHITECTURE, TRACE.
  • Internal engineering notes: JIT_STAGE5_INLINE_IC, TEST_COVERAGE_ANALYSIS, GAP_ANALYSIS, EMBED_OBSERVER_VALIDATION.
  • CI operations: CI.md.

index.md exists, but a newcomer cannot tell where to start, and there is no tutorial.

What mature languages do. Split by what the reader is doing: the Diátaxis quadrants of tutorial, how-to, reference and explanation. Python ships Tutorial / Library Reference / Language Reference / HOWTOs / What's New. Rust ships The Book / std docs / the Reference / Rust by Example / the Nomicon.

Bar.

  1. docs/guide/ holds a real tutorial whose every example runs under the executed-fence gate: install, first program, the observer in one page, a small real program.
  2. docs/reference/, docs/explanation/ and docs/internals/ (or move internals to hq) hold the existing files by audience. Every moved file is reachable from docs/index.md, which states the four sections and whom each serves.
  3. No broken links: the docs-claims PATHS class and the Pages build pass. Front doors (README, llms.txt) point at the guide first.
  4. A gate or the doc-enrolment population ensures that a new doc lands in one of the sections, not the root.

Ranked #3 of the docs follow-ups (2026-09-22 comparison with other languages). Mostly file moves, but many links.

主要言語
C
スター
3
フォーク
7
平均マージ
4時間 15分
マージ済み PR（30日）
106

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

InauguralSystems/EigenScript のほかの issue

InauguralSystems/EigenScript の issue をすべて見る

似ている issue

C の issue をもっと見る

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

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