ドキュメント

ドキュメントへの貢献の方法はシンプルです。 ファイルは https://github.com/pieceofcake2/docs の 2.x ブランチにホストされています。 自由にリポジトリをフォークして、変更・改善・翻訳を追加し、Pull Request を作成してください。 またファイルをダウンロードせず、各ページの下部にある "Edit this page on GitHub" リンクから GitHub のオンラインエディタを使って直接ドキュメントを編集することもできます。

ドキュメントは英語と日本語の Markdown で書かれ、VitePress でビルドされます。 2.x ブランチにマージされた変更は、GitHub Actions によって自動的に https://pieceofcake2.github.io/docs/ にデプロイされます。

変更をローカルで確認する方法、リポジトリの構成、翻訳のガイドライン、フォーマットガイド (見出しとアンカー、リンク、コード例、アラート、フォークでの変更点の注記) は docs リポジトリの README (英語) で説明しています。