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

@@ -0,0 +1,37 @@
---
title: "Troubleshooting & Issue Resolution"
locale: en
slug: admin-issue-resolution
audience: admin
summary: "Playbooks for the most common admin-side incidents, from stuck uploads to billing locks."
version_introduced: 2025.4
requires_app_version: "^3.2.0"
status: draft
translation_state: aligned
last_reviewed_at: 2025-02-22
owner: reliability@fotospiel.app
related:
- slug: live-ops-control
- slug: privacy-and-support
---
## Upload incidents
| Symptom | Diagnosis | Fix |
| --- | --- | --- |
| Queue stuck >10 min | Check Live Ops health widget | Run `php artisan media:backfill-thumbnails --tenant=XYZ` then reopen event |
| Specific guest blocked | Guest reached per-device limit | Increase limit under Event → Upload rules or ask them to clear drafts |
| Photos missing EXIF | Guest imported screenshots | No action; remind them that EXIF is optional |
## Access issues
- **Admin cannot log in**: verify invite accepted; reset via *Team → Resend invite*. Check SSO mapping if enforced.
- **Guest cannot join**: confirm event status is *Published* and share direct join URL `https://app.fotospiel.com/join/<code>`.
## Billing & quotas
- Paddle webhook failure locks uploads: check `storage/logs/paddle.log`, re-send webhook via Paddle dashboard, then toggle the subscription status.
- Storage 90% full: run archive early or purchase add-on via Paddle customer portal.
## Communication templates
Reuse the canned responses under `docs/content/fotospiel_howto_artikel_detailliert.md` to keep messaging consistent.
### Need more help?
Escalate to reliability@fotospiel.app with the event ID, customer account, and timestamp. Attach screenshots/logs when possible.

View File

@@ -0,0 +1,38 @@
---
title: "Event Preparation Checklist"
locale: en
slug: event-prep-checklist
audience: admin
summary: "A 48-hour countdown to ensure devices, guests, and automations are ready before doors open."
version_introduced: 2025.4
requires_app_version: "^3.2.0"
status: draft
translation_state: aligned
last_reviewed_at: 2025-02-22
owner: ops@fotospiel.app
related:
- slug: live-ops-control
- slug: post-event-wrapup
---
## 4824 hours before
- [ ] Create the event in the Admin app with correct timezone + retention policy.
- [ ] Upload cover artwork (1200×630) and ensure translations exist for titles/descriptions.
- [ ] Import guest lists or generate QR badges if needed.
- [ ] Test push notification templates (reminders, achievement unlocks).
## 242 hours before
- [ ] Run `tenant:attach-demo-event` in staging to rehearse workflow with staff.
- [ ] Print or display the join QR near entrance and photobooth areas.
- [ ] Prepare onsite Wi-Fi SSID/password signage.
- [ ] Confirm that automatic moderation rules match the client contract (e.g., block explicit content, require approval).
- [ ] Verify Paddle/RevenueCat status dashboards show green.
## Final 2 hours
- [ ] Clear demo data from the live event.
- [ ] Open the guest app on test devices and complete the getting-started flow.
- [ ] Start the Live Ops screen on a tablet/laptop near the stage.
- [ ] Brief staff on escalation paths (support contacts, backup devices, photo guidelines).
### Need more help?
Open `live-ops-control` for real-time monitoring tips or reach out to ops@fotospiel.app.

View File

@@ -0,0 +1,25 @@
---
title: "Customer Admin Help Center"
locale: en
slug: admin-help-index
audience: admin
summary: "Operational playbooks for event owners: onboarding, event setup, live control, and post-event delivery."
version_introduced: 2025.4
status: draft
translation_state: aligned
last_reviewed_at: 2025-02-22
owner: cx-team@fotospiel.app
related: []
---
This portal collects everything event admins need to configure customer accounts, run events smoothly, and resolve issues quickly. Articles are grouped by lifecycle:
| Phase | Key Questions | Article Slug |
| --- | --- | --- |
| Account Setup | How do I invite staff and configure branding? | `tenant-dashboard-overview` |
| Event Preparation | What checklists should I complete before doors open? | `event-prep-checklist` |
| Live Operations | How do I monitor uploads, moderate content, and trigger announcements? | `live-ops-control` |
| Wrap-up & Compliance | How are exports, archives, and privacy handled? | `post-event-wrapup` |
| Troubleshooting | How to handle upload issues, device loss, billing, etc. | `admin-issue-resolution` |
Use the navigation sidebar inside the admin app for faster access, or open `/help/admin` in a desktop browser for the full layout with breadcrumbs and related links.

View File

@@ -0,0 +1,39 @@
---
title: "Live Ops Control"
locale: en
slug: live-ops-control
audience: admin
summary: "Monitor uploads, moderate content, and push announcements while the event is live."
version_introduced: 2025.4
requires_app_version: "^3.2.0"
status: draft
translation_state: aligned
last_reviewed_at: 2025-02-22
owner: ops@fotospiel.app
related:
- slug: event-prep-checklist
- slug: admin-issue-resolution
---
## Dashboard widgets
- **Upload throughput** photos/minute, highlighted when backlog >25.
- **Device health** top devices experiencing errors (permission denied, storage full).
- **Moderation queue** flagged photos awaiting approval; assign to moderators.
- **Announcements** compose push/banner messages; supports locale-specific text.
## Typical workflow
1. Pin the Live Ops page on a tablet. Set auto-refresh to 15 seconds.
2. Watch the throughput graph as doors open; expect spike to 40+/min right after ceremonies.
3. If backlog grows, broadcast a banner reminding guests to stay online or reduce burst uploads.
4. Moderate flagged items quickly; policies require action within 10 minutes.
5. Use the *Achievement trigger* widget to award badges manually if automation criteria fail.
## Escalation matrix
| Issue | First action | Escalate to |
| --- | --- | --- |
| Upload queue stuck | Run health check → re-sync event | Reliability on-call |
| Offensive content | Hide photo → download evidence → notify organizer | Legal duty officer |
| Billing lock | Check Paddle dashboard → confirm payment status | Finance |
### Need more help?
Open `admin-issue-resolution` for detailed troubleshooting or ping #ops-help in Slack.

View File

@@ -0,0 +1,33 @@
---
title: "Post-Event Wrap-up"
locale: en
slug: post-event-wrapup
audience: admin
summary: "Export highlights, archive data, and fulfill privacy obligations within 72 hours after the event."
version_introduced: 2025.4
requires_app_version: "^3.2.0"
status: draft
translation_state: aligned
last_reviewed_at: 2025-02-22
owner: success@fotospiel.app
related:
- slug: event-prep-checklist
- slug: privacy-and-support
---
## First 24 hours
- Send thank-you push/email with curated highlights (select up to 40 photos → *Share link*).
- Export admin CSV (uploads, likes, reports) for your records.
- Review moderation queue to ensure no reports remain unresolved.
## Within 72 hours
- Trigger the *Archive & purge* action (Settings → Data Lifecycle). This copies media to cold storage and deletes transient caches.
- Provide guests with download links if promised in the contract.
- If GDPR deletion requests were filed, confirm completion and record the ticket ID.
## Optional follow-up
- Duplicate the event as a template for future productions.
- 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

@@ -0,0 +1,34 @@
---
title: "Customer Control Center Overview"
locale: en
slug: tenant-dashboard-overview
audience: admin
summary: "Invite staff, configure branding, and understand how customer-wide settings affect every event."
version_introduced: 2025.4
requires_app_version: "^3.2.0"
status: draft
translation_state: aligned
last_reviewed_at: 2025-02-22
owner: onboarding@fotospiel.app
related:
- slug: event-prep-checklist
- slug: admin-issue-resolution
---
## When to read this
Right after receiving access to a new customer account or when onboarding new staff. The Customer Control Center lives in the Admin app (Filament) and mirrors most options on desktop.
## Key areas
1. **Home** snapshot of live events, storage usage, unresolved reports.
2. **Team** invite admins via email, assign roles (Owner, Manager, Moderator). SSO via Azure AD/Google is available if enabled in customer settings.
3. **Branding** upload logos, choose accent colors, set localized welcome text shown in the guest app.
4. **Legal pages** edit Impressum/Privacy/AGB via the Legal resource; changes propagate instantly.
5. **Integrations** manage Paddle keys, RevenueCat app IDs, webhooks, and Zapier tokens. Never paste secrets into articles.
## 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/process/changes/`).
### Need more help?
See `event-prep-checklist` for event-level prep or contact cx-team@fotospiel.app for onboarding assistance.

View File

@@ -0,0 +1,36 @@
---
title: "Quick Start: Join an Event"
locale: en
slug: getting-started
audience: guest
summary: "Install the Fotospiel app, join an event, and learn the core gestures in under two minutes."
version_introduced: 2025.4
requires_app_version: "^3.2.0"
status: draft
translation_state: aligned
last_reviewed_at: 2025-02-22
owner: guest-success@fotospiel.app
related:
- slug: uploading-photos
- slug: offline-sync
---
## When to read this
You just received an event code or QR and want to start sharing photos. This guide assumes you have a modern mobile browser (Safari, Chrome, Edge, Samsung Internet) and basic connectivity once for the initial sync.
## Steps
1. **Open the invite link or scan the QR.** The browser launches the Fotospiel guest app landing page.
2. **Install for full-screen mode.** Tap *Add to Home Screen* (iOS) or *Install app* (Android). Installation is optional but unlocks offline mode and faster uploads.
3. **Enter the event code.** Six characters, case-insensitive. If you scanned the QR, the field auto-fills.
4. **Choose a display name.** This appears next to your uploads within the event feed. No account or email needed.
5. **Grant camera & storage permissions.** Select “Allow once” or “Allow while using the app” so Fotospiel can capture and store photos locally.
6. **Sync starter pack.** The app downloads current albums, achievements, and upload rules. A progress bar ensures everything is cached offline.
7. **Explore gestures.** Swipe up to open the camera, left/right to switch album tabs, long-press a photo to like or report.
## Tips
- Pin the app to your dock/home row before the event so you can reopen it instantly.
- If several guests share one device, clear the display name in Settings → Profile between sessions.
- Screenshots never leave your device unless you upload them manually.
### Need more help?
See `uploading-photos` for editing and batch upload tips, or `privacy-and-support` if you have questions about data retention.

View File

@@ -0,0 +1,27 @@
---
title: "Guest Help Center"
locale: en
slug: guest-help-index
audience: guest
summary: "Everything attendees need to install the Fotospiel guest app, join events, and share memories."
version_introduced: 2025.4
status: draft
translation_state: aligned
last_reviewed_at: 2025-02-22
owner: product-support@fotospiel.app
related: []
---
Welcome to the guest-focused documentation hub. Start with any of the guides below—each article is available in English and German:
- [Quick Start](./getting-started) Install the app, join an event, and learn the core gestures.
- [Upload Workflow](./uploading-photos) Capture, edit, and upload photos with background sync.
- [Offline Mode & Sync](./offline-sync) Keep contributing when connectivity drops and ensure nothing gets lost.
- [Privacy & Support](./privacy-and-support) Understand what data is stored and how to reach support.
### How to use these docs
- **Search**: Use the in-app search bar or the offline search inside the app settings. Keywords such as “upload limit” or “share link” work well.
- **Language toggle**: Switch between EN/DE via the globe icon embedded in every article.
- **Contextual links**: Many UI screens provide a `?` icon that deep-links to the relevant section here.
Need more help? Tap *Contact Support* inside the guest app → Settings → Help. Provide the event ID so we can assist faster.

View File

@@ -0,0 +1,40 @@
---
title: "Offline Mode & Sync"
locale: en
slug: offline-sync
audience: guest
summary: "Participate without coverage, queue uploads safely, and know when everything is delivered."
version_introduced: 2025.4
requires_app_version: "^3.2.0"
status: draft
translation_state: aligned
last_reviewed_at: 2025-02-22
owner: reliability@fotospiel.app
related:
- slug: uploading-photos
- slug: privacy-and-support
---
## When to read this
You expect intermittent connectivity (mountains, cellars, roaming). The guest app is built to keep working offline as long as the initial sync completed.
## What stays available offline
- Event feed (latest 250 photos) and album structure.
- Upload rules (size limits, moderation settings).
- Draft achievements and stickers.
- Help center excerpt (top 10 articles per locale) if you opened Help at least once online.
## Offline workflow
1. **Capture as usual.** Everything stores in the encrypted local queue.
2. **Review pending uploads.** Look for the grey *Queued* label. Add tags/notes even while offline.
3. **Monitor storage.** The banner warns if device storage drops below 500MB; delete sent items or transfer to another device.
4. **Reconnect briefly.** Once any network is available, open Fotospiel. Sync restarts automatically, prioritizing oldest items.
5. **Confirm completion.** A green toast “All uploads delivered” appears and the queue counter returns to zero.
## Troubleshooting
- **Stuck in “Queued” despite coverage?** Toggle airplane mode off/on, then reopen the app to reset the service worker.
- **Different devices?** Offline queues stay on the original device; theres no cross-device merge.
- **Battery saver** might pause background sync. Keep the app in the foreground for large batches.
### Need more help?
Use Settings → Help → *Send diagnostics* once you are online; support receives anonymized logs plus your event ID.

View File

@@ -0,0 +1,38 @@
---
title: "Privacy & Getting Help"
locale: en
slug: privacy-and-support
audience: guest
summary: "Understand what data is stored, how to request deletions, and how to contact support."
version_introduced: 2025.4
requires_app_version: "^3.2.0"
status: draft
translation_state: aligned
last_reviewed_at: 2025-02-22
owner: legal@fotospiel.app
related:
- slug: getting-started
- slug: offline-sync
---
## Data we store
- **Photos & captions**: Stored on the customer accounts encrypted storage for the retention period defined by the event organizer.
- **Session ID**: Anonymous token generated on your device for upload tracking; resets if you clear app storage.
- **Device metadata**: Only model + OS version, used for crash insights. No location, contacts, or advertising IDs.
## Your controls
1. **Delete individual uploads**: Open the photo → tap `…`*Remove from event*. You can delete only your own items.
2. **Erase local cache**: Settings → Storage → *Clear device copies*. This removes cached thumbnails and drafts.
3. **Request full erasure**: Use Settings → Help → *Request data deletion*. Provide email for confirmation; we forward the request to the event admin who controls the customer account.
## Support channels
- **In-app**: Settings → Help → *Contact support*. Includes optional screenshot + diagnostics bundle.
- **Email**: guests@fotospiel.app (mention event code + device model).
- **On-site**: Ask the event staff to escalate via the customer admin app.
## Response times
- Critical issues (uploads failing for entire event): &lt;15 minutes.
- Individual deletion or privacy questions: within 48 hours.
### Need more help?
Review the public legal pages (Impressum, Privacy, AGB) under Settings → Legal, or contact the event organizer directly for customer-specific policies.

View File

@@ -0,0 +1,39 @@
---
title: "Capture & Upload Photos"
locale: en
slug: uploading-photos
audience: guest
summary: "Use the built-in camera, edit shots, and rely on background sync if connectivity drops."
version_introduced: 2025.4
requires_app_version: "^3.2.0"
status: draft
translation_state: aligned
last_reviewed_at: 2025-02-22
owner: guest-success@fotospiel.app
related:
- slug: getting-started
- slug: offline-sync
---
## When to read this
You already joined an event and want to understand the capture workflow, quality limits, and what happens if uploads fail or the connection disappears.
## Step-by-step
1. **Open the Fotospiel camera.** Swipe up from the timeline or tap the shutter icon.
2. **Pick a capture mode.**
- *Single shot*: default mode with HDR tuning.
- *Burst*: hold the shutter to capture up to 5 frames; the app picks the sharpest by default.
- *Import*: tap the gallery thumbnail to select existing photos/screenshots.
3. **Apply adjustments.** Crop, rotate, or add the optional text sticker. All edits happen on-device. Tap *Save* to confirm.
4. **Choose the album & tags.** Assign to the correct chapter (e.g., Ceremony) and optionally add mood tags. Albums are cached offline.
5. **Review upload queue.** Pending items appear in the `Uploads` tab with a status pill: *Queued*, *Sending*, or *Needs attention*.
6. **Let background sync finish.** Closing the app keeps uploads going for ~30 seconds (platform limit). Reopen later to resume automatically.
7. **Fix failed uploads.** Tap the warning icon → *Retry now* or *Delete*. Common issues: airplane mode, revoked permissions, storage full.
## Tips
- Photos inherit the device timestamp; if clocks differ from event time, toggling “Use event time” adjusts metadata.
- Batch-select up to 10 pending uploads to delete or retry at once.
- Likes and comments sync separately and dont block photo uploads.
### Need more help?
Read `offline-sync` for long offline stretches or contact support from Settings → Help.

View File

@@ -0,0 +1,30 @@
---
title: "<Title>"
locale: en
slug: <slug>
audience: guest
summary: "12 sentence preview for list views."
version_introduced: 2025.4
requires_app_version: "^3.2.0"
status: draft
translation_state: draft
last_reviewed_at: 2025-02-22
owner: <team or person>
related:
- slug: <other-slug>
---
> Keep paragraphs short (max ~3 sentences) and favor ordered lists for procedures.
## When to read this
Explain the scenario, prerequisites, and expected outcome.
## Steps
1. Step explaination
2. …
### Tips
- Optional tips, variations, or FAQs.
### Need more help?
Point to support options or related articles.