Skip to content

Commit ca272dd

Browse files
authored
Merge pull request #385 from estruyf/dev
Version 2.0.0
2 parents ecfcf7e + af536dc commit ca272dd

File tree

229 files changed

+8830
-25119
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

229 files changed

+8830
-25119
lines changed

.demo/README.md

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
# Demo Time Act files
2+
3+
This folder contains demonstration files for **Demo Time** using the new
4+
**Version 3** theatrical structure.
5+
6+
## 🎭 Theatrical Structure
7+
8+
Demo Time uses an intuitive theatrical metaphor:
9+
10+
- **Play** - Your entire demo project (this workspace)
11+
- **Act** - Each act file (e.g., `example-v3.yaml` or `my-demo.json`)
12+
- **Scene** - Sections within an Act (previously called "demos")
13+
- **Move** - Individual actions (previously called "steps")
14+
15+
## 📁 Files in This Folder
16+
17+
### Version 3 (New Format)
18+
19+
- **`example-v3.yaml`** - Example demonstration using version 3 theatrical
20+
naming
21+
- Shows the new `scenes` and `moves` structure
22+
- Demonstrates product icon usage
23+
- YAML format
24+
25+
### Version 1 & 2 (Legacy Format)
26+
27+
- **`demo.json`** - Legacy JSON format demo
28+
- **`sample.json`** - Sample act file
29+
- **`sample.yaml`** - Sample YAML act file
30+
- Other `.json` and `.yaml` files - Various demo examples
31+
32+
## 🚀 Quick Start
33+
34+
### Creating a New Version 3 Demo
35+
36+
Create a file named `my-demo.yaml` (or `my-demo.json`):
37+
38+
```yaml
39+
title: My Demo Act
40+
description: What this Act demonstrates
41+
version: 3
42+
scenes:
43+
- title: Introduction Scene
44+
moves:
45+
- action: showInfoMessage
46+
message: Hello from Demo Time v3!
47+
```
48+
49+
### Product Icons
50+
51+
Choose from any VS Code codicon:
52+
- `presentation` - General presentations
53+
- `rocket` - Getting started
54+
- `lightbulb` - Features
55+
- `beaker` - Experiments
56+
- `terminal` - CLI demos
57+
- `code` - Coding tutorials
58+
59+
## 📚 Documentation
60+
61+
- **Complete Guide:** `/docs/version-3-guide.md`
62+
- **Migration Guide:** `/MIGRATION-V3.md`
63+
- **Schema:** `https://demotime.show/demo-time.schema.json`
64+
65+
## ✨ Version 3 Features
66+
67+
- ✅ Theatrical naming (Play, Act, Scene, Move)
68+
- ✅ Product icons for visual identification
69+
- ✅ Works with `.json` and `.yaml` files
70+
- ✅ Full backward compatibility with v1 & v2
71+
- ✅ Automatic normalization
72+
73+
## 🔄 Backward Compatibility
74+
75+
All existing `.json` and `.yaml` act files continue to work without
76+
modification. You can mix version 1, 2, and 3 files in the same project.
77+
78+
## 🎬 Example Structure
79+
80+
```yaml
81+
title: Getting Started
82+
version: 3
83+
scenes:
84+
- title: Installation
85+
moves:
86+
- action: create
87+
path: package.json
88+
content: {...}
89+
- action: open
90+
path: package.json
91+
92+
- title: First Steps
93+
moves:
94+
- action: showInfoMessage
95+
message: You're all set!
96+
```
97+
98+
## 📖 Learn More
99+
100+
Visit [demotime.show](https://demotime.show/) for complete documentation and
101+
examples.

.demo/example-v3.yaml

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
title: Example Version 3 Demo
2+
description: Demonstrates the new theatrical naming conventions in Demo Time v3
3+
version: 3
4+
timer: 15
5+
scenes:
6+
- id: scene-1
7+
title: Opening Scene - Introduction
8+
description: Welcome the audience and introduce the demo
9+
icons:
10+
start: play-circle
11+
end: check-circle
12+
moves:
13+
- action: create
14+
path: welcome.md
15+
content: |
16+
# Welcome to Demo Time v3!
17+
18+
This demo uses the new theatrical structure:
19+
- **Play**: Your entire demo project
20+
- **Act**: This act file (example-v3.yaml)
21+
- **Scene**: Each section of your presentation
22+
- **Move**: Individual actions that build your narrative
23+
- action: open
24+
path: welcome.md
25+
- action: waitForTimeout
26+
timeout: 2000
27+
28+
- id: scene-2
29+
title: Feature Demonstration
30+
description: Show off the key features
31+
moves:
32+
- action: create
33+
path: features.ts
34+
content: |
35+
// Demo Time v3 Features
36+
export const features = {
37+
theatrical: 'Intuitive naming structure',
38+
versioning: 'Version 3 with backward compatibility',
39+
fileFormat: 'JSON or YAML files'
40+
};
41+
- action: open
42+
path: features.ts
43+
- action: highlight
44+
path: features.ts
45+
position: "2:1:6:3"
46+
- action: showInfoMessage
47+
message: These are the new features in Demo Time v3!
48+
49+
- id: scene-3
50+
title: Closing Scene - Summary
51+
description: Wrap up and thank the audience
52+
moves:
53+
- action: closeAll
54+
- action: showInfoMessage
55+
message: Thank you for watching this Demo Time v3 presentation!

.demo/sample.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
$schema: https://demotime.show/demo-time.schema.json
22
title: Sample YAML Demo
3-
description: This is a test YAML demo file
3+
description: This is a test YAML act file
44
version: 2
55
demos:
66
- title: Step 1
@@ -10,4 +10,4 @@ demos:
1010
path: test.txt
1111
content: Hello YAML World
1212
- action: open
13-
path: test.txt
13+
path: test.txt

.demo/test-global-duplicates.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"$schema": "https://demotime.show/demo-time.schema.json",
33
"title": "Test Global Duplicates",
4-
"description": "Demo file to test global duplicate ID validation",
4+
"description": "Act file to test global duplicate ID validation",
55
"demos": [
66
{
77
"id": "demo1",

.demo/test-validation.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"$schema": "https://demotime.show/demo-time.schema.json",
33
"title": "Test Validation",
4-
"description": "Demo file to test duplicate ID validation",
4+
"description": "Act file to test duplicate ID validation",
55
"demos": [
66
{
77
"id": "demo1",

.demo/test-validation.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
$schema: https://demotime.show/demo-time.schema.json
22
title: Test YAML Validation
3-
description: YAML demo file to test duplicate ID validation
3+
description: YAML act file to test duplicate ID validation
44
demos:
55
- id: yaml-demo1
66
title: First YAML Demo

.github/copilot-instructions.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
## Key Patterns & Conventions
1919

20-
- **Demo File Format:**
20+
- **Act file Format:**
2121
- JSON or YAML, with a schema at the top-level (`$schema`).
2222
- `demos` is an array; each demo has `title`, `description`, `steps`, and optional `icons`.
2323
- Steps use a defined set of actions (see `src/utils/getActionOptions.ts`).
@@ -46,18 +46,18 @@
4646

4747
## Integration & Data Flow
4848

49-
- **Demo execution** flows from the demo file → parsed by services → actions dispatched to VS
49+
- **Demo execution** flows from the act file → parsed by services → actions dispatched to VS
5050
Code/editor APIs.
5151
- **Panels** (webviews) communicate with the extension via message passing (see `WebViewMessages` in
5252
`constants`).
5353
- **Snippets** are loaded and parameterized at runtime for reusable demo logic.
5454

5555
## Examples
5656

57-
- See `README.md` for a full demo file example.
57+
- See `README.md` for a full act file example.
5858
- See `snippets/README.md` for snippet usage and configuration.
5959

6060
---
6161

6262
For more, see [https://demotime.show](https://demotime.show) and the in-repo documentation. If you
63-
add new actions or demo file features, update the schema and documentation accordingly.
63+
add new actions or act file features, update the schema and documentation accordingly.

0 commit comments

Comments
 (0)