huge documentaton restructure for docusaurus
This commit is contained in:
Codex Agent
36
docs/help/en/guest/getting-started.md
Normal file
36
docs/help/en/guest/getting-started.md
Normal 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.
|
||||
27
docs/help/en/guest/index.md
Normal file
27
docs/help/en/guest/index.md
Normal 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.
|
||||
40
docs/help/en/guest/offline-sync.md
Normal file
40
docs/help/en/guest/offline-sync.md
Normal 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 500 MB; 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; there’s 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.
|
||||
38
docs/help/en/guest/privacy-and-support.md
Normal file
38
docs/help/en/guest/privacy-and-support.md
Normal 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 account’s 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): <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.
|
||||
39
docs/help/en/guest/uploading-photos.md
Normal file
39
docs/help/en/guest/uploading-photos.md
Normal 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 don’t block photo uploads.
|
||||
|
||||
### Need more help?
|
||||
Read `offline-sync` for long offline stretches or contact support from Settings → Help.
|
||||
Reference in New Issue
Block a user