paopao-ce/docs

Documentation Index

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

Documentation Sections

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

Recommended Reading Paths

New contributors

1. Read ../README.md
2. Follow ../INSTALL.md
3. Browse proposal/ to understand product intent and feature direction

Operators and self-hosters

1. Start with ../INSTALL.md
2. Continue into deploy/README.md
3. Use the platform-specific deployment docs that match your target environment

API and integration work

1. Review openapi/
2. Check proposal/ for feature context when endpoint behavior is tied to product design

Notes

• 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.