ドキュメントを修正する

修正 PR を歓迎します。誤字、リンク切れ、古くなった例、不明瞭な説明、翻訳を修正してください。ドキュメントのみの修正では、Issue や失敗するコードテストは必要ありません。

ローカルでプレビューする

wailsapp/wails をフォークし、そのフォークをクローンして、master からブランチを作成します。

バージョンが固定されたドキュメントジェネレーターをインストールします。

go install github.com/leaanthony/mpress/cmd/mpress@v1.0.17

M-Press v1.0.17 リリースから検証済みのバイナリをダウンロードすることもできます。

Wails リポジトリのルートで、次を実行します。

mpress version
mpress dev

docs/mpress/content/ 内の .md ソースファイルを編集します。英語がデフォルト言語で、そのファイルはこのディレクトリの直下にあります。既存の翻訳は、fr/ や id/ などの言語別フォルダーにあります。保存すると、プレビューが再ビルドされます。

各ページの先頭にあるメタデータブロックと、対になっている @... / @end コンポーネントを維持してください。通常の段落、見出し、リスト、フェンス付きコードは、テキストとして編集できます。docs/mpress/site/ 内の生成済みファイルは編集しないでください。

修正内容を確認する

python3 docs/mpress/scripts/check_translations.py
mpress build --strict --no-purge-css
mpress check
# Use `python` on Windows if `python3` is unavailable.
python3 docs/mpress/scripts/check_site.py docs/mpress/site

変更したページをブラウザーで確認し、変更したコード例があれば実行してください。翻訳を修正する場合は、変更した一節全体を英語版と比較してください。コマンド、API 名、リンク、コードサンプル、図の接続関係を維持してください。自然な技術用語を使い、要件と注意事項を保持し、本文だけでなく、図内の表示ラベル、ナビゲーションラベル、画像の説明も翻訳してください。

公開されているすべての言語には、英語版の各ページに対応する完全な翻訳が必要です。英語のプレースホルダーやフォールバックページを使用しないでください。1 つの翻訳だけを修正する場合は、その言語のみを変更できます。英語版の意味を変更する場合は、公開されている他の言語の対応ページも更新してください。無関係なページを再生成する必要はありません。

プルリクエストを提出する

master に対して PR を作成します。問題の内容と修正内容を説明し、実行した確認項目を列挙してください。目に見えるレイアウト変更についてはスクリーンショットを、変更したコード例についてはプラットフォームとバージョンの詳細を含めてください。

Cloudflare の認証情報や非公開サービスは必要ありません。公開 PR のチェックでは、デプロイ用の認証情報なしで静的サイトをビルドし、検証します。

コードの変更と機能提案については、Wails へのコントリビューションを参照してください。内部構造については、技術概要を参照してください。