Files
HiveGrid-Wireframes/03 Quellen und Referenzen/hivegrid-cloud/docs/README.md
T
2026-07-08 16:15:37 +02:00

31 lines
2.7 KiB
Markdown

# docs/ — Wegweiser (HiveGrid-Technik-Referenz)
`docs/` ist **technische Plattform-Referenz** plus HiveGrid-spezifische Entscheidungs-/Bau-Dokumente.
> **Du willst PLANEN/steuern?** → nicht hier, sondern **`.planning/`** (Live-Planung: PROJECT, ROADMAP, STATE, REQUIREMENTS, ENTITY-MODEL).
> **Du willst BAUEN?** → `docs/milestones/` (die PLAN.md je Milestone) + `docs/ARCHITECTURE-DECISIONS.md` + `docs/INTEGRATION-CONTRACTS.md`.
**Stand:** 2026-07-01 · Infra-Realität: **Hetzner + Coolify + Cloudflare**.
## HiveGrid-spezifisch (wichtig, gepflegt)
| Datei/Ordner | Inhalt |
|---|---|
| **ARCHITECTURE-DECISIONS.md** | verbindliche ADRs (inkl. Projekt-zentrisches Modell und Bespoke-Pivot) |
| **INTEGRATION-CONTRACTS.md** | Modul-Integrationsvertrag (Sidebar/Routes/Search/Notifications/Entitlement-Gate) |
| **milestones/** | Milestone-PLANs — **aktiv** von `.planning/PHASE-SOURCES.md` referenziert |
| **feature-inventory.md** + **feature-decisions/** + **feature-manifests/** | Feature-Klassifikation. ⚠ `feature-manifests/*.json` werden **zur Laufzeit/von Tests geladen** — nicht anfassen |
| **TC-PLANNING-BRIEFING.md** · **MID-STREAM-CHANGES.md** · **PROGRESS-TRACKER.md** | Agent-Briefing · Rollback-Playbook · Live-Fortschritts-Tracker |
## Plattform-Referenz (Boilerplate — Nachschlagen, selten Startpunkt)
deployment*.md · worker.md · database.md / db-*.md · mail*.md · env-vars.md / env-access-inventory.md · plugins.md · api.md · observability.md · security.md + **security/** · **architecture/** · troubleshooting.md · upgrade(s).md · versioning.md · configuration.md · local-dev.md · quickstart.md · production-checklist.md / release-checklist.md · roles-matrix.md · data-retention.md
## Betriebs-/Spezial-Ordner
- **ops/** = operative Runbooks (Queues, PgBouncer, Backups, CDN, Lago-Staging/Production-Prep, Billing-Meter)
- **operations/** = Setup/Admin-Guides (Authentik-SSO, Plugin-Lifecycle) — *Namens-Doppel mit ops/, Konsolidierung wäre ein Aufräum-Kandidat*
- **observability/** = Monitoring (Sentry/Logging/Metrics)
- **deploy/** (Service-Runbooks, z.B. Meilisearch) · **deployments/** (Referenz-Deploy boiler-saas-ctrl) · **agent-playbooks/** · **contributing/** · **testing/** · **plugins/** · **ui-inventory/** · **compliance/** · **storage/** · **auth/** · **verification/**
## Historisch — NICHT Startpunkt
- **archive/** · **releases/** · **reports/** — abgeschlossene Artefakte.
- Die früheren Boilerplate-Abgleichs-Ordner (`boilerplate-mapping/`, `boilerplate-inventory/`, `improvement-plan/`) wurden im Bespoke-Cleanup entfernt. Quelle für HiveGrid sind `.planning/`, `docs/milestones/`, `docs/ARCHITECTURE-DECISIONS.md` und die Ticket-Docs.