📚 Simutrans ドキュメント索引(全ページ)
概要
Simutrans プロジェクトの技術ドキュメントを横断的に参照できる索引ページです。docs ディレクトリ配下の全 Markdown ページへのリンクをカテゴリ別に一覧化しています。初学者からコントリビューターまで、目的の情報へ素早く到達できるように整理しています。
対象読者:
- 初めてコードベースに触れる開発者
- 仕様や内部構造を調べたい開発者
- 特定システムの詳細を深掘りしたいコントリビューター
目的
- 全ページの網羅的なリンク集を提供
- ドキュメントの発見性・回遊性を向上
- カテゴリ単位での学習・参照を支援
基本的な使用方法
- 目的のカテゴリを選び、該当ドキュメントを開いてください。
- 具体的なキーワードがある場合はエディタ内検索(Ctrl/Cmd + P/Shift+P)と併用してください。
- 迷った場合は「ガイド」→「アーキテクチャ」→「システム」の順で読むことをおすすめします。
メインコンテンツ
📂 guides/(入門・セットアップ)
🏗️ architecture/(設計・全体像)
🎮 systems/(個別システム仕様)
関連ファイル
- 索引ページ:
docs/ALL_PAGES.md
- トップページ:
docs/README.md
- ガイド:
docs/guides/README.md
- アーキテクチャ:
docs/architecture/README.md
- システム:
docs/systems/README.md
まとめ
この索引は docs 配下の全ページをカテゴリ別に整理したものです。ドキュメントの増減に合わせて適宜更新してください。新規ドキュメントを追加した際は、カテゴリ README と本索引の両方にリンクを追記すると発見性が高まります。
参考リンク