90 lines
3.8 KiB
Markdown
90 lines
3.8 KiB
Markdown
# 📚 Nyash Documentation
|
||
|
||
## 🚀 はじめに
|
||
- **現在のタスク**: [../CURRENT_TASK.md](../CURRENT_TASK.md)
|
||
- **コア概念の速習**: [reference/architecture/nyash_core_concepts.md](reference/architecture/nyash_core_concepts.md)
|
||
|
||
---
|
||
|
||
## 📂 ドキュメント構造（指針）
|
||
|
||
### 📖 [reference/](reference/) - 正式な技術仕様
|
||
- **language/** - 言語仕様（構文、型システム、Box仕様）
|
||
- **architecture/** - システムアーキテクチャ（MIR、VM、実行バックエンド）
|
||
- **api/** - ビルトインBoxのAPI仕様
|
||
- **plugin-system/** - プラグインシステム、BID-FFI仕様
|
||
- 🆕🔥 **[TypeBox ABI統合 + セルフホスティング](../development/roadmap/phases/phase-12/)** - ABIすらBoxとして扱う革命的設計！
|
||
- まずはこちら: `reference/boxes-system/plugin_lifecycle.md`（PluginBoxV2のライフサイクル、singleton、nyash.tomlの要点）
|
||
|
||
### 📚 [guides/](guides/) - 利用者向けガイド
|
||
- **getting-started.md** - はじめに（統一版）
|
||
- **tutorials/** - ステップバイステップのチュートリアル
|
||
- **examples/** - 実践的なサンプルコード
|
||
- **wasm-guide/** - WebAssemblyビルドガイド
|
||
|
||
### 🧩 [how-to/](how-to/) - 目的別ハウツー
|
||
- 手順重視の短いガイド（前提→コマンド→検証）
|
||
|
||
### 🔧 [development/](development/) - 開発者向け
|
||
- **current/** - 現在進行中のタスク（CURRENT_TASK.md等）
|
||
- **roadmap/** - 開発計画
|
||
- phases/ - Phase 8～12の詳細計画
|
||
- phase-12/ - 🆕🔥 TypeBox統合ABI + Nyash ABI C実装（セルフホスティング実現！）
|
||
- native-plan/ - ネイティブビルド計画
|
||
- **proposals/** - RFC、新機能提案
|
||
|
||
### 🔌 Net Plugin（HTTP/TCP）
|
||
- 使い方と仕様: `reference/plugin-system/net-plugin.md`
|
||
|
||
### 🗄️ [archive/](archive/) - アーカイブ
|
||
- **consultations/** - AI相談記録（gemini/chatgpt/codex）
|
||
- **decisions/** - 過去の設計決定
|
||
- **build-logs/** - ビルドログ、ベンチマーク結果
|
||
- **old-versions/** - 古いドキュメント
|
||
|
||
---
|
||
|
||
## 🎯 クイックアクセス
|
||
|
||
### すぐ始める
|
||
- [Getting Started](guides/getting-started.md)
|
||
- [Language Guide](guides/language-guide.md)
|
||
- [P2P Guide](guides/p2p-guide.md)
|
||
|
||
### 技術リファレンス
|
||
- [言語リファレンス](reference/language/LANGUAGE_REFERENCE_2025.md)
|
||
- [アーキテクチャ概要](reference/architecture/TECHNICAL_ARCHITECTURE_2025.md)
|
||
- [実行バックエンド](reference/architecture/execution-backends.md)
|
||
- [GC モードと運用](reference/runtime/gc.md)
|
||
- [プラグインシステム](reference/plugin-system/)
|
||
- [CLIオプション早見表](tools/cli-options.md)
|
||
|
||
### デザイン
|
||
- [設計ノート（入口）](design/)
|
||
|
||
### 開発状況
|
||
- [現在のタスク](../CURRENT_TASK.md)
|
||
- [開発ロードマップ](development/roadmap/)
|
||
- [Phase別計画](development/roadmap/phases/)
|
||
- 🔥 **[Phase 12: TypeBox統合ABI](development/roadmap/phases/phase-12/)** - プラグイン革命！
|
||
|
||
---
|
||
|
||
## 📋 再編成について / フォルダの見分け方
|
||
ドキュメントは2025年8月20日に再編成されました。詳細は[REORGANIZATION_REPORT.md](REORGANIZATION_REPORT.md)を参照してください。
|
||
|
||
旧パスから新パスへの主な変更：
|
||
- `説明書/` → `guides/` と `reference/` に分割
|
||
- `予定/` → `development/roadmap/`
|
||
- 散在していたファイル → 適切なカテゴリに整理
|
||
|
||
---
|
||
|
||
補足:
|
||
- `reference/` は正本（仕様）。
|
||
- `guides/` は読み物、`how-to/` は手順書。
|
||
- `design/` は公開できる設計ノート。
|
||
- `private/` は下書き保管庫（将来 `reference/`/`design/` に昇格）。
|
||
|
||
Nyash は「Everything is Box」哲学に基づく言語です。詳細はコア概念とガイドを参照してください。
|