English | 简体中文
This directory contains project documentation for development, deployment, API assets, design notes, and community discussions around PaoPao.
If you are looking for the main project entry points, start from:
- ../README.md - project overview
- ../INSTALL.md - installation and local setup guide
| Section | Description |
|---|---|
| openapi/ | Exported API documentation assets, including generated OpenAPI files and static docs artifacts |
| proposal/ | Product ideas, design proposals, and implementation notes |
| deploy/ | Deployment references for local, cloud, and Kubernetes environments |
| discuss/ | Discussion-oriented documents, notes, and related references |
- Read ../README.md
- Follow ../INSTALL.md
- Browse proposal/ to understand product intent and feature direction
- Start with ../INSTALL.md
- Continue into deploy/README.md
- Use the platform-specific deployment docs that match your target environment
- Review openapi/
- Check proposal/ for feature context when endpoint behavior is tied to product design
openapi/is primarily a generated documentation asset bundle rather than a hand-written narrative section.proposal/contains historical and ongoing design material, so some documents reflect exploration rather than final behavior.discuss/may include working notes and community-oriented references in addition to formal documentation.