完善开发文档
This commit is contained in:
+9
-12
@@ -1,17 +1,14 @@
|
||||
# Welcome to MkDocs
|
||||
# Patbond 项目文档
|
||||
|
||||
For full documentation visit [mkdocs.org](https://www.mkdocs.org).
|
||||
Patbond 是面向宠物主人的社区、健康管理、AI 内容创作与本地服务平台。
|
||||
|
||||
## Commands
|
||||
当前项目由三个仓库组成:
|
||||
|
||||
* `mkdocs new [dir-name]` - Create a new project.
|
||||
* `mkdocs serve` - Start the live-reloading docs server.
|
||||
* `mkdocs build` - Build the documentation site.
|
||||
* `mkdocs -h` - Print help message and exit.
|
||||
- `patbond-flutter`:产品界面与本地交互 Demo。
|
||||
- `patbond-api`:Java/Spring Cloud 后端,当前实现身份注册和登录原型。
|
||||
- `patbond-doc`:项目文档与 PostgreSQL 数据模型。
|
||||
|
||||
## Project layout
|
||||
## 开发入口
|
||||
|
||||
mkdocs.yml # The configuration file.
|
||||
docs/
|
||||
index.md # The documentation homepage.
|
||||
... # Other markdown pages, images and other files.
|
||||
- [开发实施文档](development/development-plan.md):当前基线、架构原则、接口约定、迭代计划和验收标准。
|
||||
- [PostgreSQL 数据库脚本](database/patbond_postgresql.sql):本地开发数据库的目标结构及示例数据。
|
||||
|
||||
Reference in New Issue
Block a user