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/introduction.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/introduction.rst')
| -rw-r--r-- | Documentation/source/ja/introduction.rst | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/Documentation/source/ja/introduction.rst b/Documentation/source/ja/introduction.rst new file mode 100644 index 0000000..731db1e --- /dev/null +++ b/Documentation/source/ja/introduction.rst @@ -0,0 +1,46 @@ +プロジェクト概要 +================ + +Next Blog は、読む体験を中心にしたフルスタックのブログプラットフォームです。公開サイトは Next.js App Router で構築し、コンテンツ管理には Payload CMS を使います。認証、コメント、アプリケーションデータは PostgreSQL、Drizzle ORM、better-auth、Fuma Comments で扱います。 + +プロダクト範囲 +-------------- + +現在の主な機能は次のとおりです。 + +* Payload CMS による記事の作成、編集、公開; +* ホーム、記事一覧、記事詳細、タグページ、プロフィールページの表示; +* Google と GitHub OAuth によるログイン; +* ログインユーザー向けのコメント機能; +* 検索インデックス、RSS、サイトマップ、JSON-LD、Open Graph 画像の出力; +* Newsletter フォームと React Email テンプレート。 + +このプロジェクトは汎用コミュニティ CMS ではありません。公開側は読書体験に、管理側は編集作業に集中した個人向けの発信基盤です。 + +主要なロール +------------ + +.. list-table:: + :header-rows: 1 + :widths: 20 34 36 + + * - ロール + - 目的 + - 主な入口 + * - 訪問者 + - コンテンツを閲覧して読む。 + - ``/``、``/posts``、``/posts/[slug]``、``/tags`` + * - リピーター + - タグで絞り込み、更新を追う。 + - ``/tags/[tag]``、``/rss.xml`` + * - ログインユーザー + - コメントやアカウント関連操作を行う。 + - ``/login``、``/posts/[slug]`` + * - コンテンツ管理者 + - 記事を管理、予約、公開する。 + - ``/admin`` + +ドキュメント方針 +---------------- + +``Documentation/source`` はこのリポジトリの正式な Sphinx ドキュメントソースです。``docs/`` の Markdown は調査メモや下書きとして残せますが、継続的に参照するエンジニアリング文書は reStructuredText としてここに整理します。 |
