summaryrefslogtreecommitdiff
path: root/Documentation/source/reference/commands.rst
diff options
context:
space:
mode:
authorBertrand Yuan <me@bertyuan.com>2026-04-27 20:52:54 +0800
committerBertrand Yuan <me@bertyuan.com>2026-04-27 20:53:14 +0800
commitdbb5e791f0c228369605d126dd590962ebe1eddc (patch)
tree8c83fc84bd9547630e6733929dec77e102e055a8 /Documentation/source/reference/commands.rst
parent658798b3a2378bb6df16cfbb16d707c6fb719e1e (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/reference/commands.rst')
-rw-r--r--Documentation/source/reference/commands.rst96
1 files changed, 96 insertions, 0 deletions
diff --git a/Documentation/source/reference/commands.rst b/Documentation/source/reference/commands.rst
new file mode 100644
index 0000000..8268400
--- /dev/null
+++ b/Documentation/source/reference/commands.rst
@@ -0,0 +1,96 @@
+Command Reference
+=================
+
+Application
+-----------
+
+.. list-table::
+ :header-rows: 1
+ :widths: 24 52
+
+ * - Command
+ - Description
+ * - ``pnpm dev``
+ - Start the Next.js development server.
+ * - ``pnpm build``
+ - Build the production application.
+ * - ``pnpm start``
+ - Start a built production server.
+ * - ``pnpm preview``
+ - Build and start the production server.
+
+Quality
+-------
+
+.. list-table::
+ :header-rows: 1
+ :widths: 24 52
+
+ * - Command
+ - Description
+ * - ``pnpm lint``
+ - Run project link validation and Biome linting.
+ * - ``pnpm check``
+ - Run Biome checks.
+ * - ``pnpm format``
+ - Format files with Biome.
+ * - ``pnpm test``
+ - Run Vitest once.
+ * - ``pnpm test:watch``
+ - Run Vitest in watch mode.
+ * - ``pnpm test:coverage``
+ - Run tests with coverage.
+
+Data and CMS
+------------
+
+.. list-table::
+ :header-rows: 1
+ :widths: 28 48
+
+ * - Command
+ - Description
+ * - ``pnpm db:generate``
+ - Generate Drizzle migration files.
+ * - ``pnpm db:migrate``
+ - Apply Drizzle migrations.
+ * - ``pnpm db:push``
+ - Push Drizzle schema changes directly.
+ * - ``pnpm db:studio``
+ - Open Drizzle Studio.
+ * - ``pnpm payload:generate``
+ - Generate Payload TypeScript types.
+ * - ``pnpm payload:migrate``
+ - Run Payload migrations.
+ * - ``pnpm payload:migrate:create``
+ - Create a Payload migration.
+
+Email
+-----
+
+.. list-table::
+ :header-rows: 1
+ :widths: 24 52
+
+ * - Command
+ - Description
+ * - ``pnpm email:dev``
+ - Start React Email preview server on port 3001.
+ * - ``pnpm email:build``
+ - Build email templates.
+ * - ``pnpm email:export``
+ - Export email templates.
+
+Documentation
+-------------
+
+.. list-table::
+ :header-rows: 1
+ :widths: 28 48
+
+ * - Command
+ - Description
+ * - ``make -C Documentation html``
+ - Build Sphinx HTML documentation.
+ * - ``make -C Documentation clean``
+ - Remove generated Sphinx build output.