Skip to content

Commit aaff2a9

Browse files
enedclaude
andcommitted
feat: improve documentation UX and content quality
- Add dark blue theme with higher contrast (#1e3a8a primary) - Remove redundant cross-links between use case pages (handled by sidebar) - Eliminate repetitive intro paragraph from quickstart page - Add Xcode Help link for Background Modes configuration - Add explanatory callout for iOS task identifier requirements - Improve user guidance and reduce confusion 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent db4da8d commit aaff2a9

4 files changed

Lines changed: 7 additions & 11 deletions

File tree

docs.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
{
22
"name": "Flutter Workmanager",
33
"description": "Background task execution for Flutter apps",
4+
"theme": {
5+
"primaryColor": "#1e3a8a",
6+
"accentColor": "#3b82f6"
7+
},
48
"sidebar": [
59
{
610
"group": "Getting Started",

docs/quickstart.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: Quick Start
33
description: Get started with Flutter Workmanager in minutes
44
---
55

6-
Get Flutter Workmanager up and running in your app quickly.
7-
86
## Installation
97

108
Add `workmanager` to your `pubspec.yaml`:
@@ -29,7 +27,7 @@ Android works automatically - no additional setup required! ✅
2927
### iOS
3028
iOS requires a 5-minute setup in Xcode:
3129

32-
1. **Enable Background Modes** in Xcode target capabilities:
30+
1. **Enable Background Modes** in Xcode target capabilities ([Xcode Help](https://help.apple.com/xcode/mac/current/#/devbfa1532c4)):
3331
- Background processing ✅
3432
- Background fetch ✅
3533

@@ -57,6 +55,8 @@ WorkmanagerPlugin.registerBGProcessingTask(
5755
)
5856
```
5957

58+
> **Why this configuration is needed:** iOS requires explicit registration of background task identifiers for security and system resource management. The task identifier in Info.plist tells iOS which background tasks your app can schedule, while the AppDelegate registration connects the identifier to the actual task handler. This prevents apps from scheduling unauthorized background work.
59+
6060
## Basic Usage
6161

6262
### 1. Create Background Task Handler

docs/usecases/data-sync.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -334,7 +334,3 @@ Future<bool> _performIncrementalSync() async {
334334
- Use compression for large payloads
335335
- Cache API responses appropriately
336336

337-
## Related Use Cases
338-
339-
- **[Upload Files](upload-files)** - Upload user content in the background
340-
- **[Fetch Notifications](fetch-notifications)** - Check for new notifications from your server

docs/usecases/upload-files.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,3 @@ Future<bool> _uploadWithRetry(Map<String, dynamic> inputData) async {
265265
}
266266
```
267267

268-
## Related Use Cases
269-
270-
- **[Data Sync](data-sync)** - Synchronize data with your backend
271-
- **[Database Maintenance](database-maintenance)** - Clean up and optimize local data

0 commit comments

Comments
 (0)