> ## Documentation Index
> Fetch the complete documentation index at: https://supastack.dev/llms.txt
> Use this file to discover all available pages before exploring further.
> For the full documentation corpus in one file, fetch: https://supastack.dev/llms-full.txt

# 产品文档

套件随附的专用文档应用。

## 开始之前

使用“文件”→“打开文件夹”在 Visual Studio Code 中打开下载的 supastack 项目，然后选择“终端”→“新建终端”。存储库根目录是包含 package.json、apps 和 packages 的文件夹。运行下面的命令并保持终端打开。如果无法识别命令，请先完成工具安装指南，然后再继续。

首先阅读平台教程。服务器是响应浏览器或电话请求的应用程序进程。 Web 读取 apps/web/.env.local，Expo 读取 apps/mobile/.env.local，数据库迁移命令读取 root .env。无数据库/仪表板演示与真实/身份验证帐户分开，需要迁移Postgres。仅电话或桌面结帐需要单独运行的 Web 后端。

[安装工具并获取代码](https://supastack.dev/zh/docs/web/before-you-start.md)

[学习命令、文件和配置](https://supastack.dev/zh/docs/web/terminal-basics.md)

[完成Web首次运行教程](https://supastack.dev/zh/docs/web/ship-in-5-minutes.md)

```
corepack pnpm --filter @supastack/web dev
```


## 安装与配置

apps/docs 是面向购买者的文档端面,服务于你构建的产品 —— 与这套套件文档分开。它以导航、页内锚点和搜索渲染你产品自己的指南,并在开发中作为独立的 workspace 应用运行在 3001 端口。

让其内容与其描述的功能一起,在仓库中保持类型化和版本化;与代码脱节的文档比缺失的页面更糟。

```
apps/docs/        Product documentation app
  content/        Guide sources and nav order
  app/            Routes, layout, search
```


## 实现流程

以套件结构为模板来组织你的产品文档:一条起步路径、每个功能区域一页,以及配置和 API 的参考页。复用套件的指南格式,使工具(搜索索引、复制为 Markdown)继续可用。

将任务与页面关联:发布功能时,在同一变更中更新对应指南。


## 验证与排障

构建 docs 工作区,点遍每个导航项,对引入的每个新术语执行一次搜索,并在重命名后检查锚点链接。将损坏的文档链接视为损坏的路由。


## 下一篇

[功能开关与公告](https://supastack.dev/zh/docs/web/feature-flags.md)