diff options
| author | Bertrand Yuan <me@bertyuan.com> | 2026-04-27 20:52:54 +0800 |
|---|---|---|
| committer | Bertrand Yuan <me@bertyuan.com> | 2026-04-27 20:53:14 +0800 |
| commit | dbb5e791f0c228369605d126dd590962ebe1eddc (patch) | |
| tree | 8c83fc84bd9547630e6733929dec77e102e055a8 /Documentation/source/ja/reference.rst | |
| parent | 658798b3a2378bb6df16cfbb16d707c6fb719e1e (diff) | |
docs: add comprehensive documentation for operations
This commit introduces a complete set of documentation files
covering various aspects of the project, including environment
setup, quality checks, command references, and architecture.
The documentation is structured to assist developers and
contributors in understanding the project's configuration,
workflow, and best practices.
Additionally, translations for Simplified and Traditional
Chinese have been added to ensure accessibility for a wider
audience. This enhances the overall usability and
maintainability of the project.
Signed-off-by: Bertrand Yuan <github@bertyuan.com>
Diffstat (limited to 'Documentation/source/ja/reference.rst')
| -rw-r--r-- | Documentation/source/ja/reference.rst | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/Documentation/source/ja/reference.rst b/Documentation/source/ja/reference.rst new file mode 100644 index 0000000..aa0600a --- /dev/null +++ b/Documentation/source/ja/reference.rst @@ -0,0 +1,57 @@ +リファレンス +============ + +よく使うコマンド +---------------- + +.. list-table:: + :header-rows: 1 + :widths: 26 50 + + * - コマンド + - 説明 + * - ``pnpm dev`` + - 開発サーバーを起動する。 + * - ``pnpm build`` + - 本番アプリケーションをビルドする。 + * - ``pnpm lint`` + - コンテンツリンク検証と Biome lint を実行する。 + * - ``pnpm test`` + - テストを実行する。 + * - ``pnpm db:migrate`` + - Drizzle migration を適用する。 + * - ``pnpm payload:generate`` + - Payload TypeScript 型を生成する。 + +ルート +------ + +.. code-block:: text + + / + /posts + /posts/[slug] + /tags + /tags/[tag] + /about + /login + /admin + /api/auth/[...all] + /api/comments/[...comment] + /api/search + /rss.xml + +用語 +---- + +Payload + 記事、ユーザー、メディア、管理画面を扱う CMS。 + +Drizzle + アプリケーション所有のデータベーステーブルを扱う TypeScript ORM。 + +better-auth + OAuth とセッションを提供する認証ライブラリ。 + +BlogPost + ``src/lib/payload-posts.ts`` が返すフロントエンド向けの正規化済み記事構造。 |
