summaryrefslogtreecommitdiff
path: root/Documentation/source/index.rst
blob: 1f7103b5b80197de8ddca4714627315ce6f8f7f5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
Next Blog Documentation
=======================

Next Blog is a full-stack blog platform built with Next.js, Payload CMS,
PostgreSQL, Drizzle ORM, better-auth, and Fuma Comments. This documentation
tree describes the product intent, system architecture, runtime operations,
frontend conventions, and contribution workflow for the repository.

The structure intentionally follows a subsystem-oriented layout: top-level
indexes introduce each area, while deeper pages describe concrete flows,
interfaces, and operational responsibilities. Keep this page small; add new
material under the nearest subsystem directory.

Audience
--------

This documentation is written for:

* maintainers who need to understand the shape of the codebase;
* contributors who need repeatable setup and contribution rules;
* operators who need environment, database, and release notes;
* designers and frontend engineers who need UI conventions.

Project Map
-----------

.. list-table::
   :header-rows: 1
   :widths: 24 56

   * - Area
     - Responsibility
   * - ``src/app/(main)``
     - Public site routes, layouts, API endpoints, feeds, and Open Graph images.
   * - ``src/app/(payload)``
     - Payload CMS admin routes and API bridge.
   * - ``src/components``
     - Shared UI, rich text rendering, layout sections, auth widgets, and forms.
   * - ``src/lib``
     - Application helpers for content access, metadata, validation, actions,
       email, and client utilities.
   * - ``src/server``
     - Database connection, Drizzle schema, authentication, and comment storage.
   * - ``src/payload``
     - Payload collection definitions for posts, users, and media.
   * - ``content``
     - MDX content consumed by the Fumadocs content pipeline.
   * - ``Documentation/source``
     - Sphinx source files for this documentation set.

Contents
--------

.. toctree::
   :maxdepth: 2

   introduction
   getting-started

.. toctree::
   :maxdepth: 2

   architecture/index

.. toctree::
   :maxdepth: 2

   frontend/index

.. toctree::
   :maxdepth: 2

   operations/index

.. toctree::
   :maxdepth: 2

   contributing/index

.. toctree::
   :maxdepth: 2

   reference/index