Quick reference, API docs, glossary, and FAQs
Quick Reference: API Reference | FAQ | Glossary | Quick Start Cheatsheet
The reference/ directory contains quick reference materials, API documentation, glossaries, and frequently asked questions for fast lookup.
| File | Purpose | Audience |
|---|---|---|
api-reference.md |
API documentation | Developers |
api-project-modules.md |
Project-side module API reference | Developers |
glossary.md |
Terms and definitions | All users |
faq.md |
Frequently asked questions | All users |
quick-start-cheatsheet.md |
Essential commands reference | All users |
common-workflows.md |
Step-by-step workflow recipes | All users |
copypasta.md |
Ready-to-use sharing content | All users |
copypasta-diagrams.md |
Diagram copypasta blocks | All users |
copypasta-outreach.md |
Outreach / social copypasta | All users |
opengauss-naming.md |
math-inc gauss CLI vs Huawei OpenGauss DBMS |
Developers, agents |
→ Check FAQ - Common questions
→ Use Quick Start Cheatsheet - Essential commands
→ Reference API Reference - API docs
→ Consult Glossary - Definitions
→ Use Common Workflows - Step-by-step recipes
../core/how-to-use.md- usage guide../guides/- Skill-level specific guides../operational/troubleshooting/- Troubleshooting
../documentation-index.md- documentation index../README.md- Documentation hub overview