Skip to content

Commit a2791f8

Browse files
docs: add Examples and Documentation index (repo-specific, English-only) (#5)
1 parent 05026ff commit a2791f8

File tree

2 files changed

+38
-24
lines changed

2 files changed

+38
-24
lines changed

Documentation/README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Documentation Index
2+
3+
- [](&)Documentation/AccessibilityAPI.md
4+
- [](&)Documentation/AccessibilityGuide.md
5+
- [](&)Documentation/AnimationGuide.md
6+
- [](&)Documentation/API-Reference.md
7+
- [](&)Documentation/API.md
8+
- [](&)Documentation/API/Charts.md
9+
- [](&)Documentation/BarChartAPI.md
10+
- [](&)Documentation/Best-Practices.md
11+
- [](&)Documentation/ChartAPI.md
12+
- [](&)Documentation/ChartTypesGuide.md
13+
- [](&)Documentation/CustomizationAPI.md
14+
- [](&)Documentation/CustomizationGuide.md
15+
- [](&)Documentation/Getting-Started.md
16+
- [](&)Documentation/GettingStarted.md
17+
- [](&)Documentation/Guides/GettingStarted.md
18+
- [](&)Documentation/Installation.md
19+
- [](&)Documentation/LineChartAPI.md
20+
- [](&)Documentation/PerformanceAPI.md
21+
- [](&)Documentation/PerformanceGuide.md
22+
- [](&)Documentation/PieChartAPI.md
23+
- [](&)Documentation/ResponsiveDesignGuide.md
24+
- [](&)Documentation/ScatterPlotAPI.md
25+
- [](&)Documentation/Troubleshooting.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/AdvancedChartsExample.swift
5+
- ``Examples/AnalyticsExample/AnalyticsDashboard.swift
6+
- ``Examples/AnimationExamples/AnimationExamples.swift
7+
- ``Examples/BasicExample.swift
8+
- ``Examples/BasicExamples/BasicChartsExample.swift
9+
- ``Examples/BasicExamples/BasicLineChartExample.swift
10+
- ``Examples/CustomizationExamples/CustomizationExamples.swift
11+
- ``Examples/InteractiveExamples/InteractiveChartsExample.swift
12+
- ``Examples/InteractiveExamples/InteractiveExamples.swift
13+
- ``Examples/PerformanceExamples/PerformanceExamples.swift

0 commit comments

Comments
 (0)