Skip to content

Commit 03d8126

Browse files
committed
docs: fix examples catalog
1 parent 11e7ec4 commit 03d8126

2 files changed

Lines changed: 10 additions & 22 deletions

File tree

CONTRIBUTING.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,8 +85,9 @@ Go to your fork on GitHub and click **Compare & pull request**.
8585
- `documents/` - Document examples
8686
- `presentations/` - Presentation examples
8787
- `spreadsheets/` - Spreadsheet examples
88+
- `tables/` - Table-focused examples
89+
- `modular/` - Modular documents with includes
8890
- `combined/` - Multi-format examples
89-
- `advanced/` - Complex examples
9091
- `use-cases/` - Real-world scenarios
9192

9293
---

README.md

Lines changed: 8 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Perfect for beginners learning OSF syntax:
1414
- **[02-basic-document.osf](getting-started/02-basic-document.osf)** - Formatting, headings, lists (5 min) ⏱️
1515
- **[03-simple-presentation.osf](getting-started/03-simple-presentation.osf)** - Slides with layouts (5 min) ⏱️
1616
- **[04-basic-spreadsheet.osf](getting-started/04-basic-spreadsheet.osf)** - Data tables and formulas (10 min) ⏱️
17+
- **[v1.1-new-features.osf](getting-started/v1.1-new-features.osf)** - v1.1 syntax highlights
1718

1819
### 📄 Documents
1920
Professional document examples:
@@ -33,8 +34,6 @@ Business and educational slide decks:
3334
Data analysis and tracking sheets:
3435
- **[budget-tracker.osf](spreadsheets/budget-tracker.osf)** - Personal/business budget
3536
- **[sales-dashboard.osf](spreadsheets/sales-dashboard.osf)** - Sales metrics dashboard
36-
- **[expense-report.osf](spreadsheets/expense-report.osf)** - Expense tracking with formulas
37-
- **[inventory-management.osf](spreadsheets/inventory-management.osf)** - Inventory system
3837

3938
### 📋 Tables (v1.3+)
4039
Professional tables with styling and alignment:
@@ -52,22 +51,10 @@ Document composition using @include directive:
5251
### 🎯 Combined
5352
Multi-format documents demonstrating OSF's versatility:
5453
- **[business-report.osf](combined/business-report.osf)** - Doc + Slides + Sheets in one file
55-
- **[project-proposal.osf](combined/project-proposal.osf)** - Comprehensive project proposal
56-
- **[annual-report.osf](combined/annual-report.osf)** - Full annual business report
57-
58-
### ⚡ Advanced
59-
Complex examples showcasing advanced features:
60-
- **[complex-formulas.osf](advanced/complex-formulas.osf)** - Advanced Excel-style formulas
61-
- **[nested-tables.osf](advanced/nested-tables.osf)** - Complex table structures
62-
- **[multi-theme.osf](advanced/multi-theme.osf)** - Theme switching demonstration
63-
- **[large-dataset.osf](advanced/large-dataset.osf)** - Performance testing with large data
6454

6555
### 💡 Use Cases
6656
Real-world application scenarios:
6757
- **[llm-prompts.osf](use-cases/llm-prompts.osf)** - AI/LLM prompt documentation
68-
- **[api-documentation.osf](use-cases/api-documentation.osf)** - Technical API docs
69-
- **[classroom-materials.osf](use-cases/classroom-materials.osf)** - Educational content
70-
- **[personal-finance.osf](use-cases/personal-finance.osf)** - Personal finance tracking
7158

7259
---
7360

@@ -198,16 +185,16 @@ git push origin add-example-name
198185
### By Feature
199186
- **Markdown formatting**: `02-basic-document.osf`
200187
- **Slide layouts**: `03-simple-presentation.osf`
201-
- **Formulas**: `04-basic-spreadsheet.osf`, `complex-formulas.osf`
202-
- **Multi-format**: All files in `combined/` folder
203-
- **Themes**: `multi-theme.osf`
204-
- **Large scale**: `large-dataset.osf`
188+
- **Formulas**: `04-basic-spreadsheet.osf`, `budget-tracker.osf`
189+
- **Tables**: `basic-table.osf`, `styled-table.osf`, `sales-report.osf`
190+
- **Modular includes**: `modular/main.osf`
191+
- **Multi-format**: `combined/business-report.osf`
205192

206193
### By Use Case
207194
- **Business**: `business-pitch.osf`, `quarterly-review.osf`, `business-report.osf`
208-
- **Education**: `training-slides.osf`, `classroom-materials.osf`
209-
- **Technical**: `technical-report.osf`, `api-documentation.osf`, `user-manual.osf`
210-
- **Personal**: `meeting-notes.osf`, `personal-finance.osf`, `budget-tracker.osf`
195+
- **Education**: `training-slides.osf`
196+
- **Technical**: `technical-report.osf`, `user-manual.osf`
197+
- **Personal**: `meeting-notes.osf`, `budget-tracker.osf`
211198
- **AI/LLM**: `llm-prompts.osf`
212199

213200
---

0 commit comments

Comments
 (0)