マニュアルの更新方法

このサイトはMarkdownとソースから抽出したリファレンスで構成します。ブラウザーで文章を編集するCMSは使用しません。

初回準備

Node.js、npm、.NET 10 SDK、PowerShellを用意します。リポジトリのDocs/Websiteで次を実行します。

npm ci
npm run docs:generate
npm run docs:dev

ブラウザーに表示されるローカルURLを開きます。ローカルサーバーを止めるには、そのターミナルでCtrl+Cを押します。

文章を変更する

guideとmanualのMarkdownを編集します。文章の見出しは日本語、API名はコードと同じ表記を使用します。説明には操作手順、期待する結果、前提条件、保存の扱いを含めます。

apiとcomponentsなどの自動生成ページは、直接編集すると次の生成で上書きされます。説明の追加・修正はTools/Documentationの説明データを変更します。

コードが変わった場合

1. 掲載対象の一覧を再生成します。
2. 追加・削除されたAPIやInspectorの差分を確認します。
3. 変わった挙動と関連する説明を修正します。
4. コード例、リンク、掲載対象、生成結果を検証します。
5. 確認したソースの一覧を更新し、公開用ファイルを生成します。

npm run docs:generate
npm run docs:check

確認したソースの更新方法と公開コマンドは、同じFolderのREADME.mdを参照してください。自動抽出は宣言の正確さを補助するもので、意味や実際の画面の確認を代わりに行うものではありません。

公開

npm run docs:build
npm run docs:deploy

公開にはCloudflareのアカウントと初回のブラウザー認証が必要です。公開先は設定した同じPages Projectを再利用します。パスワードやAPIキーをMarkdownやソースへ書かないでください。

生成物だけを公開するため、Engineのソース、ゲームAsset、個人ログはアップロードしません。Gitのcommit・pushはこの更新手順では行いません。

URL共有について

このサイトはログインなしで読めます。検索エンジンへの掲載抑制は設定していますが、URLが転送された人の閲覧を拒否するものではありません。外部へ出せない内容を掲載する場合は、別途アクセス認証を導入してください。