AGENTS.md@docs/reference · diff

git:20260503.72c1838 to git:20260528.db613f8

1 added, 1 removed. Audit A to A.

# Reference Documentation

## Overview

Technical guide for `docs/reference/` — API docs, glossary, FAQ, workflows, and quick reference materials.

## Files

| File | Purpose |

|------|---------|

| `api-reference.md` | Unified API documentation for infrastructure + project modules |

| `api-project-modules.md` | Project-side module API reference |

| `glossary.md` | Comprehensive glossary of terms |

| `faq.md` | Frequently asked questions |

| `quick-start-cheatsheet.md` | One-page essential commands |

| `common-workflows.md` | Step-by-step task recipes |

| `copypasta.md` | Ready-to-use content for sharing the template |

| `copypasta-diagrams.md` | Diagram copypasta blocks |

| `copypasta-outreach.md` | Outreach / social copypasta |

| `opengauss-naming.md` | math-inc Open Gauss CLI vs Huawei DBMS (disambiguation) |

## Key Conventions

- - **Layer 2 examples**: prefer paths under [`projects/template_code_project/`](../../projects/template_code_project/); other active projects → [_generated/active_projects.md](../_generated/active_projects.md).

+ - **Layer 2 examples**: prefer paths under [`projects/templates/template_code_project/`](../../projects/templates/template_code_project/); other active projects → [_generated/active_projects.md](../_generated/active_projects.md).

- `api-reference.md` covers both Layer 1 (infrastructure) and Layer 2 (project) modules

- FAQ answers are kept concise with links to detailed guides

- Workflow recipes follow consistent format: context → steps → verification

- Glossary terms are alphabetized and cross-referenced

## See Also

- [README.md](README.md) — Quick navigation

- [API Reference](api-reference.md) — Full API docs

- [Modules Guide](../modules/modules-guide.md) — Module-level docs