huge documentaton restructure for docusaurus

This commit is contained in:
Codex Agent
2025-11-20 10:44:29 +01:00
parent 0127114e59
commit 6afa44d947
87 changed files with 18867 additions and 4102 deletions

View File

@@ -11,17 +11,24 @@ This folder defines the bilingual help center that serves both guest app users a
## Directory Layout
```
docs/help/
├── README.md # This blueprint
├── templates/ # Authoring templates per locale
├── guest/ # Guest-focused articles (paired locales)
│ ├── index.en.md
│ └── index.de.md
└── admin/ # Customer admin articles (paired locales)
├── index.en.md
└── index.de.md
├── README.md
├── en/
│ ├── admin/
│ ├── index.md
│ └──
│ ├── guest/
│ │ ├── index.md
│ │ └──
│ └── templates/
│ └── article.md
└── de/
├── admin/
├── guest/
└── templates/
```
- Articles live in the audience folder and follow the naming pattern `<slug>.<locale>.md` (e.g., `offline-sync.en.md`).
- Each article includes YAML front matter to describe metadata used by the app and Filament resource.
- English and German live under their respective locale folders, which keeps slugs unique for the Docusaurus build (`/help/en/admin/...`, `/help/de/guest/...`).
- Inside each locale folder, article filenames match their slug (e.g., `post-event-wrapup.md`). Paired locales keep the same slug and metadata.
- Every article includes the YAML front matter shown below so the apps and Filament know how to render status, owners, etc.
## Front Matter Contract
```yaml
@@ -72,7 +79,7 @@ related:
- **Standalone Web**: optional `/help` public site generated from the same Markdown using Vite/React and server-side rendering for SEO.
## Governance & Backlog
- Track work in `docs/todo/help.md` (create if needed) and link issues to article slugs.
- Track work in `docs/process/todo/help.md` (create if needed) and link issues to article slugs.
- Add CI checks:
- Ensure every `.en.md` file has a matching `.de.md` file with equal `slug`/`version_introduced`.
- Validate required front matter keys.

View File

@@ -27,7 +27,7 @@ related:
## Optionaler Follow-up
- Event als Vorlage duplizieren für zukünftige Produktionen.
- Erkenntnisse oder Verbesserungswünsche in `docs/todo/` festhalten.
- Erkenntnisse oder Verbesserungswünsche in `docs/process/todo/` festhalten.
### Weitere Hilfe
Wende dich an success@fotospiel.app oder konsultiere die Legal-Pages-Ressource für Compliance-Formulierungen.

View File

@@ -28,7 +28,7 @@ Direkt nach dem Zugriff auf einen neuen Kunden oder wenn neue Mitarbeitende eing
## Best Practices
- Mindestens zwei Owner-Rollen für Redundanz halten.
- Branding oder Automationen zuerst im Staging-Kundenkonto testen.
- Einladungen im Änderungslog (`docs/changes/`) dokumentieren.
- Einladungen im Änderungslog (`docs/process/changes/`) dokumentieren.
### Weitere Hilfe
Siehe `event-prep-checklist` für Event-Vorbereitung oder kontaktiere cx-team@fotospiel.app für Onboarding-Support.

View File

@@ -31,7 +31,7 @@ related:
- **Vor Ort**: Event-Personal ansprechen; sie eskalieren über die Admin-App.
## Antwortzeiten
- Kritische Probleme (Uploads für gesamtes Event gestört): <15 Minuten.
- Kritische Probleme (Uploads für gesamtes Event gestört): &lt;15 Minuten.
- Individuelle Lösch- oder Datenschutzanfragen: innerhalb von 48 Stunden.
### Weitere Hilfe

View File

@@ -27,7 +27,7 @@ related:
## Optional follow-up
- Duplicate the event as a template for future productions.
- Update `docs/todo/` with learnings or improvements for the product team.
- Update `docs/process/todo/` with learnings or improvements for the product team.
### Need more help?
Reach success@fotospiel.app or consult the Legal Pages resource for compliance wording.

View File

@@ -28,7 +28,7 @@ Right after receiving access to a new customer account or when onboarding new st
## Best practices
- Keep at least two Owner-level accounts for redundancy.
- Use the staging customer account to test branding or automation before touching production.
- Document invitations in the change log (`docs/changes/`).
- Document invitations in the change log (`docs/process/changes/`).
### Need more help?
See `event-prep-checklist` for event-level prep or contact cx-team@fotospiel.app for onboarding assistance.

View File

@@ -31,7 +31,7 @@ related:
- **On-site**: Ask the event staff to escalate via the customer admin app.
## Response times
- Critical issues (uploads failing for entire event): <15 minutes.
- Critical issues (uploads failing for entire event): &lt;15 minutes.
- Individual deletion or privacy questions: within 48 hours.
### Need more help?