From dbb5e791f0c228369605d126dd590962ebe1eddc Mon Sep 17 00:00:00 2001 From: Bertrand Yuan Date: Mon, 27 Apr 2026 20:52:54 +0800 Subject: 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 --- Documentation/source/ja/frontend.rst | 49 ++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 Documentation/source/ja/frontend.rst (limited to 'Documentation/source/ja/frontend.rst') diff --git a/Documentation/source/ja/frontend.rst b/Documentation/source/ja/frontend.rst new file mode 100644 index 0000000..a85ae22 --- /dev/null +++ b/Documentation/source/ja/frontend.rst @@ -0,0 +1,49 @@ +フロントエンド +============== + +ページ責務 +---------- + +.. list-table:: + :header-rows: 1 + :widths: 22 34 44 + + * - ルート + - 主なファイル + - 責務 + * - ``/`` + - ``src/app/(main)/(home)/page.tsx`` + - Hero、最新記事、Newsletter CTA を含むホーム。 + * - ``/posts`` + - ``src/app/(main)/(home)/posts/page.tsx`` + - 公開済み記事のページ付き一覧。 + * - ``/posts/[slug]`` + - ``src/app/(main)/(home)/posts/[slug]/page.tsx`` + - 記事詳細、リッチテキスト、メタデータ、共有、コメント。 + * - ``/tags`` + - ``src/app/(main)/(home)/tags/page.tsx`` + - タグ一覧と記事数。 + * - ``/tags/[tag]`` + - ``src/app/(main)/(home)/tags/[...slug]/page.tsx`` + - タグで絞り込んだ記事一覧。 + * - ``/login`` + - ``src/app/(main)/(auth)/login/page.tsx`` + - OAuth ログイン入口。 + +UI 原則 +------- + +* 読みやすさを優先し、タイポグラフィ、行幅、コントラストを調整する。 +* 記事、タグ、検索、テーマ切替、アカウント操作にすぐアクセスできるようにする。 +* 点線ボーダー、角マーカー、控えめなモーションという既存の視覚言語を保つ。 +* モバイルとデスクトップで同じ情報階層を維持する。 + +コンポーネント規約 +------------------ + +新しいコンポーネントを作る前に ``src/components/ui`` と既存ページの実装を確認します。共通コンポーネントは正規化された props を受け取り、データ取得は Server Component または ``src/lib`` helper に置きます。アイコンのみのボタンには必ずアクセシブルな名前を付けます。 + +アクセシビリティ +---------------- + +カスタム操作にはキーボードフォーカスを残します。アイコンボタンやリンクには読み上げ可能な名前を付けます。ライトテーマとダークテーマの両方で十分なコントラストを保ち、フォームは空・読み込み・成功・エラー状態を扱います。 -- cgit v1.2.3