smalruby3-editor 機能ドキュメント
smalruby3-editor の機能ドキュメントは ユーザーストーリー単位 で 1 機能 = 1 ディレクトリにまとめている。
各 docs/<feature>/ は scratch-gui を起点に、scratch-vm(拡張機能・ランタイム)、infra/(API・relay)、ruby/(gem)を横断的に参照 する統合ドキュメント。「この機能を知りたければここだけ見れば OK」を目指す。
体系の設計経緯と運用方針は Issue #610 および .claude/rules/documentation.md を参照。
凡例:
🆕 Smalruby 独自 — upstream に存在しない、Smalruby のために新規追加された機能
🔧 upstream 改良 — upstream にあるが Smalruby で機能を改良・拡張している
⬆️ upstream そのまま — upstream の実装をほぼそのまま利用
⏳ 執筆未着手 / ✏️ 執筆中 / ✅ 執筆完了
機能
upstream 区分
状態
project-management/ — プロジェクト新規作成・読込・保存・タイトル編集・URL ローダー・SB3 ダウンロード
🔧 改良
✅
block-editor/ — ブロックパレット・ツールボックス・ワークスペース・変数モニター・カスタムブロック
🔧 改良
✅
stage/ — ステージ表示・緑旗/停止・ステージサイズ・背景・watermark・表示モード
🔧 改良
✅
sprite/ — スプライト一覧・選択・追加・座標/向き/サイズ編集
⬆️ そのまま
✅
costume/ — コスチュームタブ・ペイントエディタ・コスチュームライブラリ・コスチューム操作ブロック
⬆️ そのまま
✅
sound/ — 音タブ・サウンドエディタ・サウンドライブラリ・録音・音操作ブロック
⬆️ そのまま
✅
機能
upstream 区分
状態
ruby-editor/ — Ruby タブ・Monaco・ruby-toolbar・ruby-generator・ruby-to-blocks-converter
🆕 独自
✅
furigana/ — ふりがな表示モード
🆕 独自
✅
dncl/ — 日本語プログラミング (DNCL) モード
🆕 独自
✅
rubytee/ — ルビティー(「生成AI に相談」の[ルビティーにまかせる]。scratch-gui + infra 統合)
🆕 独自
✅
backpack/ — バックパック (mesh v1 → v2 移行ロジック含む)
🔧 改良
✅
機能
upstream 区分
状態
mobile-ui/ — モバイル/タブレット UI 全般(旧 docs/sp/)
🆕 独自
✅
menu-bar/ — メニューバー・言語切替・アカウントメニュー・「?」メニュー(チュートリアル / デバッグの入口)
🔧 改良
✅
tutorial/ — cards・tips-library・tutorial-onboarding・classroom-tutorial
🔧 改良
✅
lessons/ — コース › レッスン › チャレンジのデータ・端末への記録・レッスンモード
🆕 独自
✏️
alerts/ — alerts・crash-message・error-boundary・coming-soon・browser/webgl-modal
⬆️ そのまま
✅
settings/ — Ruby バージョン切替・各種設定永続化
🔧 改良
✅
screenshot/ — blocks-screenshot・ruby-screenshot
🆕 独自
✅
design-system/ — 上流の GUI のデザイントークン・部品の形と、独自の画面のための別名(smalruby-tokens.css)
🔧 改良
✏️
analytics/ — GA の計測(GTM / GA4 の設定のいまの状態・新しい計測を足す手順)
🔧 改良
✅
F. 開発者向け(パッケージ内部仕様 / インフラ)
ドキュメント
内容
scratch-vm/ — VM 内部仕様 (Runtime / Sequencer / Thread / Target / Blocks / Extensions / Serialization / Blocks Runtime)
開発者向け(Issue #620 完了)
infra/ — AWS CDK インフラ全体 (mesh-v2 / rubytee-relay / classroom / smalruby-api の横断ドキュメント)
開発者・運用向け(Issue #625)
hosting/ — 本番 smalruby.app の配信(GitHub Pages → S3 + CloudFront の計画・切り替えと戻し方・費用)
開発者・運用向け
smalruby3-gem/ — Ruby SDL2 デスクトップランタイム (ruby/smalruby3/)
gem 開発者向け(Issue #625 Phase 2)
scratch-render/ — WebGL ステージレンダラー内部仕様
レンダラー開発者向け(Issue #625 Phase 4)
scratch-svg-renderer/ — SVG 前処理パッケージ内部仕様
レンダラー開発者向け(Issue #625 Phase 4)
新しい機能ドキュメントを書くときは _template.md をコピーして使う。