Skip to content

Commit 0c5307e

Browse files
docs: add Examples and Documentation index (repo-specific, English-only) (#6)
1 parent 839adaa commit 0c5307e

File tree

2 files changed

+41
-24
lines changed

2 files changed

+41
-24
lines changed

Documentation/README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Documentation Index
2+
3+
- [](&)Documentation/API-Reference.md
4+
- [](&)Documentation/API.md
5+
- [](&)Documentation/APIReference.md
6+
- [](&)Documentation/ArchitectureGuide.md
7+
- [](&)Documentation/Best-Practices.md
8+
- [](&)Documentation/ConfigurationAPI.md
9+
- [](&)Documentation/CustomizationAPI.md
10+
- [](&)Documentation/CustomizationGuide.md
11+
- [](&)Documentation/DataIntegrationAPI.md
12+
- [](&)Documentation/DataIntegrationGuide.md
13+
- [](&)Documentation/DynamicIslandAPI.md
14+
- [](&)Documentation/DynamicIslandGuide.md
15+
- [](&)Documentation/Getting-Started.md
16+
- [](&)Documentation/GettingStarted.md
17+
- [](&)Documentation/HomeScreenWidgetAPI.md
18+
- [](&)Documentation/HomeScreenWidgetGuide.md
19+
- [](&)Documentation/Installation.md
20+
- [](&)Documentation/InstallationGuide.md
21+
- [](&)Documentation/LiveActivityAPI.md
22+
- [](&)Documentation/LiveActivityGuide.md
23+
- [](&)Documentation/LockScreenWidgetAPI.md
24+
- [](&)Documentation/LockScreenWidgetGuide.md
25+
- [](&)Documentation/PerformanceGuide.md
26+
- [](&)Documentation/Troubleshooting.md
27+
- [](&)Documentation/UsageGuide.md
28+
- [](&)Documentation/WidgetDevelopmentManagerAPI.md

Examples/README.md

Lines changed: 13 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,13 @@
1-
# 💡 Examples
2-
3-
Welcome to our comprehensive examples collection! Here you'll find practical implementations and usage patterns for our framework.
4-
5-
## 📱 Available Examples
6-
7-
### Basic Example
8-
- **File**: `BasicExample.swift`
9-
- **Description**: Simple implementation showing fundamental usage
10-
- **Difficulty**: Beginner
11-
- **Use Case**: Quick prototyping and learning
12-
13-
## 🚀 Getting Started
14-
15-
1. **Choose an example** that matches your skill level
16-
2. **Copy the code** into your project
17-
3. **Customize** according to your needs
18-
4. **Build and run** to see it in action
19-
20-
## 📚 Related Documentation
21-
22-
- [Getting Started](Documentation/GettingStarted.md)
23-
- [API Reference](Documentation/API.md)
24-
- [Installation Guide](Documentation/Installation.md)
1+
# Examples Index
2+
3+
- ``Examples/AdvancedExample.swift
4+
- ``Examples/AdvancedExamples/AdvancedWidgetExample.swift
5+
- ``Examples/BasicExample.swift
6+
- ``Examples/BasicExamples/BasicWidgetExample.swift
7+
- ``Examples/DynamicIslandExamples/DynamicIslandExample.swift
8+
- ``Examples/HomeScreenWidgetExamples/HomeScreenWidgetExample.swift
9+
- ``Examples/HomeScreenWidgetExamples/WeatherWidgetExample.swift
10+
- ``Examples/LiveActivityExamples/FitnessTrackerExample.swift
11+
- ``Examples/LiveActivityExamples/LiveActivityExample.swift
12+
- ``Examples/LockScreenWidgetExamples/CalendarWidgetExample.swift
13+
- ``Examples/LockScreenWidgetExamples/LockScreenWidgetExample.swift

0 commit comments

Comments
 (0)