docs: GitHub Copilotのカスタム指示を追加

.github/copilot-instructions.md

@@ -0,0 +1,78 @@
+# Copilot instructions
+
+このリポジトリは、[Typst](https://typst.app/)の公式ドキュメントを日本語に翻訳するプロジェクトにおける、コーディングエージェント用の初期セットアップガイドです。エージェントは作業を開始する前に必ずこのファイルを参照し、記載された手順や制約に従ってください。
+
+## リポジトリの概要
+
+- リポジトリの目的は、Typstの公式ドキュメントを日本語へ翻訳し、Webサイトとして公開することです。
+- 依存ツールの管理やタスクランナーとしてmiseを使用します。RustやNode.jsなどのランタイム、jqなどのツールは`mise`で管理されます。
+- Node.jsのパッケージ管理はBunを使用します。
+- GitHub Actions（`website.yml`）では、miseタスクを実行し、ビルド、textlint、デプロイを行います。
+
+### 主要なディレクトリの構成
+
+- `docs/`: 翻訳対象のMarkdownドキュメントとドキュメントのジェネレーター（typst-docs）。チュートリアル系の文章はここで管理されます。ページ名や見出しの翻訳、リンク解決などは`docs/src/`に書かれたRustコードに依存しており、翻訳者は必要に応じてこのコードを調整します。
+- `crates/`: 翻訳対象のrustdocドキュメント。リファレンス系の文章はここで管理されます。rustdocのみを編集対象とし、コード本体は変更しません。
+- `website/`: Webサイトのメタデータと静的サイトジェネレーター（typst-docs-web）。翻訳状況は`website/translation-status.json`で管理されます。
+
+## 初回セットアップ
+
+このリポジトリは`website/typst-docs-web`をGitサブモジュールとして含んでいます（`.gitmodules` を参照）。初めてクローンする場合は以下のいずれかを実行してください。
+
+```bash
+# HTTPS
+git clone --recursive https://github.com/typst-jp/docs.git
+
+# SSH
+git clone --recursive git@github.com:typst-jp/docs.git
+```
+
+もしすでにクローン済みであれば：
+
+```bash
+git submodule update --init --recursive
+```
+
+また、`mise run`を使う前に一度だけ以下を実行してください（詳細は `CONTRIBUTING.md`を参照）。
+
+```bash
+mise trust    # このリポジトリの`mise.toml`を信頼
+mise install  # Rust, Node.js, jqなどのツールをインストール
+```
+
+## 開発の流れ
+
+開発や検証は、リポジトリのルートから`mise run`コマンドを使用して行います。
+
+### よく使うコマンド
+
+- `mise run generate`: `docs.json`を再生成し静的Webサイトをビルドします。ドキュメント編集後は必ず実行してください。
+- `mise run preview`: ビルド済みの成果物をプレビューするサーバー（`http://localhost:4173/docs/`）を起動します。
+- `mise run textlint-md`: Markdownの文章をtextlintで校正します。
+- `mise run textlint-html`: 生成されたHTMLの文章をtextlintで校正します。
+
+## 翻訳の基本方針
+
+- `TRANSLATING_GUIDELINES.md`および`docs/glossary.md`を必ず確認し、プロジェクト固有の訳語ルールと方針に厳密に従ってください。
+- 日本語における標準的なIT技術用語・プログラミング用語を使用して翻訳してください。
+- 日本語の表現習慣を考慮して、語順を変更し、文の成分を補足して、文が日本語の文脈に合った流暢さを保つようにしてください。
+- 文脈に応じて固有名詞や多義語の翻訳を決定してください。直接的な日本語の対応語がない単語は原文を保持し、可能な場合は注釈を提供してください。
+- 流暢で読みやすく、元の情報が完全に保持されるように翻訳してください。
+- コードブロック中の記述は翻訳しないでください。
+
+## Pull Request作成時の確認事項
+
+- `mise run generate`を実行し、ビルドエラーが出ないことを確認する。
+- `mise run textlint-md`および`mise run textlint-html`を実行して警告を解消する。
+- 訳語や文法が`TRANSLATING_GUIDELINES.md`や`docs/glossary.md`に沿っているか確認する。
+- `website/translation-status.json`の翻訳状況を更新する。
+
+## エージェントへの補足
+
+- `docs.json`と`assets/`は自動生成されるので、編集やコミットをしてはいけません。
+- 日本語の表現はtextlintの指摘を尊重してください。設定は`prh.yaml`や`.textlintrc.js`にあります。
+- miseタスクの詳細は`mise.toml`にあります。
+- 人間向けの貢献ガイドは`CONTRIBUTING.md`にあります。
+- `target/`, `node_modules/`フォルダは検索時は無視してください。
+
+これらの指示を信頼し、足りない情報や誤りがあれば検索や調査を行ってください。

CONTRIBUTING.md

@@ -107,7 +107,7 @@ mise install
 
 ドキュメントデータのJSONファイルは、typst-docsによりTypstのソースコード内のコメントおよび`docs/`にあるMarkdownファイル群から生成されます。
 
-`mise run generate-docs`を実行すると、ドキュメントデータのJSONファイルが`assets/docs.json`に生成されます。
+`mise run generate-docs`を実行すると、ドキュメントデータのJSONファイルがリポジトリルートの`docs.json`に生成されます。
 
 ```sh
 mise run generate-docs
@@ -117,7 +117,7 @@ mise run generate-docs
 
 Webサイトの生成にはNode.jsとViteとHonoを使用しています。また、パッケージ管理にBunを使用しています。
 
-`mise run generate-web`を実行すると、`assets/docs.json`を基にWebサイトのデータが`website/dist/`に生成されます。
+`mise run generate-web`を実行すると、`docs.json`を基にWebサイトのデータが`website/typst-docs-web/dist/`に生成されます。
 
 ```sh
 mise run generate-web