slidict 0.5.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bcb8c90bc5cd08ea0215119e5b04eb6fbe7e9ed44c8ee5f6d5ef2a7aaaa884de
-  data.tar.gz: cef002ffa756fa6a30af65df47cd1c157ceb1187cc021b31ced01de41e73f2c1
+  metadata.gz: d9219a4421ee2daa082652c0967bbc585fff8aadf8ba90becbee2d3293597252
+  data.tar.gz: e1d4fa02a468b3b51d28681168151983cf89464d1dfb9e309d3c8b2a5e56dbee
 SHA512:
-  metadata.gz: fa541a9126446303bf5e4b8ef0e1cc852311e6d1d9d022db1446594e49e76a7a56fd379100c727296c70cdf09c2379b954cb057cdea63902716d1d153573d58f
-  data.tar.gz: 9119b310faaa5442a01c716b79e804f9f5f9e90c2d9cd8cb06977905e9d976d45b915e2d1138775ddc36c8306c1528b96a8402e0e3045058d9c66d0c849da15d
+  metadata.gz: b17f7f5c07ebb337c964e14a0884e2cd8502da2664cbe3d3f8553296596e3cbc40497c2b659fd494dd778effae1ce4c51b9b714266b6527fd2cbc9b233dd5fa9
+  data.tar.gz: 273809d25f6adf3551113f9bd2d7a7d664d3fb58a8e8bac1634dff46e4c41d0c873925537012c1b8c3f7f3e30af18a12b3a497a65835d83c1c4eebc8941d30b5

data/README.md

@@ -6,6 +6,14 @@ Slidict is a CLI tool that helps you turn rough ideas into presentations through
 
 Unlike traditional slide generators, Slidict focuses on communication before slide creation.
 
+## Demo
+
+![Slidict conversation-to-slides demo](docs/demo.gif)
+
+![Slidict presentation methods demo](docs/demo-methods.gif)
+
+[Read the walkthrough slides on slidict.io](https://slidict.io/slides/140)
+
 ## Features
 
 - Interactive CLI conversation
@@ -215,137 +223,32 @@ Slides
 
 We optimize for communication, not decoration.
 
-## Roadmap
-
-- [x] Interactive CLI
-- [x] Slide generation
-- [x] OpenAI Compatible API support (configurable base URL, so Ollama, LM Studio, and other compatible servers work out of the box)
-- [x] Presentation structure linter (`slidict lint`)
-
-## License
-
-MIT
-
 ## Presentation methods
 
-Slidict supports data-driven presentation methods. A method defines the narrative
-technique, slide roles, AI instructions, and review checklist in YAML, while the Ruby
-gem only loads, validates, and applies that data.
+Use `--method` to generate slides with a specific narrative structure, such as SCQA, PREP, or Pyramid Principle.
 
 ```bash
-bin/slidict new --method prep --topic "New onboarding flow"
 bin/slidict --method scqa --topic "Database migration plan"
-bin/slidict --method pyramid --topic "FY roadmap recommendation"
 bin/slidict list-methods
 bin/slidict show-method scqa
 ```
 
-Built-in methods currently include SCQA, PREP, and Pyramid Principle.
-
-### Method architecture
-
-The method system is intentionally data-first:
-
-1. YAML files live in `data/slidict/methods/`.
-2. `Slidict::PresentationMethodRegistry` discovers built-in files and plugin-provided files.
-3. `Slidict::PresentationMethod` validates each YAML document and maps it to Ruby objects.
-4. `Slidict::Deck` uses the method's slide roles as the built-in non-LLM outline.
-5. `Slidict::Llm::Client` injects the method description, slide roles, and AI instructions into the generation prompt.
-
-This keeps contribution review small: a new built-in method is usually one YAML file and no Ruby code.
-
-### Directory structure
-
-```text
-data/slidict/methods/
-  prep.yml
-  pyramid.yml
-  scqa.yml
-lib/slidict/presentation_method.rb
-```
-
-For 100+ methods, keep one method per file and use stable lowercase IDs such as
-`scqa`, `prep`, `pyramid`, or `problem-solution`. Categories are free-form labels
-that can later drive filtering without changing the file layout.
-
-### YAML schema
-
-Each method file is a single YAML mapping:
-
-```yaml
-id: scqa
-name: SCQA
-category: narrative
-description: Situation, Complication, Question, Answer structure for building a clear business narrative.
-locale: en
-suitable_for:
-  - Strategy updates
-  - Problem-solving proposals
-slides:
-  - title: Situation
-    role: Establish the shared context the audience already recognizes.
-    instructions: Describe the current state with concrete facts.
-ai_instructions:
-  - Use the SCQA sequence exactly.
-review_checklist:
-  - Does the situation establish common ground?
-references:
-  - title: The Pyramid Principle
-    author: Barbara Minto
-```
-
-Required fields are `id`, `name`, `category`, `description`, `suitable_for`,
-`slides`, `ai_instructions`, and `review_checklist`. `references` and `locale` are
-optional; `locale` defaults to `en`. Every slide entry requires `title`, `role`, and
-`instructions`.
-
-### Ruby class design
-
-- `Slidict::PresentationMethod` represents one method definition.
-- `Slidict::MethodSlide` represents each slide role.
-- `Slidict::PresentationMethodRegistry` loads built-in YAML files and plugin YAML files.
-- `Slidict::Deck` accepts an optional `presentation_method` and turns method slide roles into a local template when `--no-llm` is used or no LLM is configured.
-
-Validation happens at load time with `YAML.safe_load_file`. Slidict checks required
-fields, requires lowercase method IDs (`a-z`, `0-9`, and `-`), and verifies that each
-slide role has the required fields.
-
-### CLI design
-
-- `--method ID` applies a method to generated slides.
-- `list-methods` prints every discovered method.
-- `show-method ID` prints a method's description, use cases, slide roles, and review checklist.
-
-### Plugin design
-
-External gems can distribute methods without changing Slidict itself. A plugin gem only
-needs to place YAML files under `lib/slidict/methods/*.yml` so RubyGems can expose them
-through `Gem.find_files`.
+See [Presentation methods](docs/presentation-methods.md) for the YAML schema, plugin layout, and contribution workflow.
 
-Example plugin layout:
+## Project resources
 
-```text
-slidict-methods-product/
-  lib/slidict/methods/product-demo.yml
-  slidict-methods-product.gemspec
-```
-
-After the plugin gem is installed, Slidict automatically includes those YAML files in
-`list-methods`, `show-method`, and `--method` lookup.
+- [Presentation method guide](docs/presentation-methods.md)
+- [Changelog](CHANGELOG.md)
+- [Code of conduct](CODE_OF_CONDUCT.md)
+- [License](LICENSE)
 
-### Future localization
-
-Method files include a `locale` field. The recommended future shape is one file per
-localized method, for example `scqa.en.yml` and `scqa.ja.yml`, with the same method ID
-plus locale-aware lookup. Keeping all user-facing text in YAML means translations can be
-reviewed independently from Ruby changes.
+## Roadmap
 
-### OSS contribution workflow
+- [x] Interactive CLI
+- [x] Slide generation
+- [x] OpenAI Compatible API support (configurable base URL, so Ollama, LM Studio, and other compatible servers work out of the box)
+- [x] Presentation structure linter (`slidict lint`)
 
-To propose a new presentation method:
+## License
 
-1. Copy an existing YAML file in `data/slidict/methods/`.
-2. Change `id`, `name`, `category`, `description`, `suitable_for`, `slides`, `ai_instructions`, and `review_checklist`.
-3. Add `references` when useful.
-4. Run `bundle exec rspec` and `bundle exec rubocop`.
-5. Open a PR with the method file and a short explanation of the communication technique.
+MIT

data/docs/demo-methods.tape

@@ -0,0 +1,31 @@
+Output docs/demo-methods.gif
+
+Set Shell "bash"
+Set FontSize 18
+Set Width 1000
+Set Height 600
+Set Theme "Dracula"
+
+Type "bin/slidict list-methods"
+Enter
+Sleep 2s
+
+Type "bin/slidict --method scqa --framework marp"
+Enter
+Sleep 1s
+
+Type "Database migration plan"
+Enter
+Sleep 800ms
+
+Type "10 minutes"
+Enter
+Sleep 800ms
+
+Type "Engineering leadership"
+Enter
+Sleep 800ms
+
+Type "Approve the migration timeline"
+Enter
+Sleep 2s

data/docs/demo.tape

@@ -0,0 +1,27 @@
+Output docs/demo.gif
+
+Set Shell "bash"
+Set FontSize 18
+Set Width 1000
+Set Height 600
+Set Theme "Dracula"
+
+Type "bin/slidict --framework marp"
+Enter
+Sleep 1s
+
+Type "PDF Difference Monitoring Service"
+Enter
+Sleep 800ms
+
+Type "5 minutes"
+Enter
+Sleep 800ms
+
+Type "Engineering managers"
+Enter
+Sleep 800ms
+
+Type "Approve an MVP pilot"
+Enter
+Sleep 2s

data/docs/presentation-methods.md

@@ -0,0 +1,125 @@
+# Presentation methods
+
+Slidict supports data-driven presentation methods. A method defines the narrative
+technique, slide roles, AI instructions, and review checklist in YAML, while the Ruby
+gem only loads, validates, and applies that data.
+
+## Using methods
+
+```bash
+bin/slidict new --method prep --topic "New onboarding flow"
+bin/slidict --method scqa --topic "Database migration plan"
+bin/slidict --method pyramid --topic "FY roadmap recommendation"
+bin/slidict list-methods
+bin/slidict show-method scqa
+```
+
+Built-in methods currently include SCQA, PREP, and Pyramid Principle.
+
+## Architecture
+
+The method system is intentionally data-first:
+
+1. YAML files live in `data/slidict/methods/`.
+2. `Slidict::PresentationMethodRegistry` discovers built-in files and plugin-provided files.
+3. `Slidict::PresentationMethod` validates each YAML document and maps it to Ruby objects.
+4. `Slidict::Deck` uses the method's slide roles as the built-in non-LLM outline.
+5. `Slidict::Llm::Client` injects the method description, slide roles, and AI instructions into the generation prompt.
+
+This keeps contribution review small: a new built-in method is usually one YAML file and no Ruby code.
+
+## Directory structure
+
+```text
+data/slidict/methods/
+  prep.yml
+  pyramid.yml
+  scqa.yml
+lib/slidict/presentation_method.rb
+```
+
+For 100+ methods, keep one method per file and use stable lowercase IDs such as
+`scqa`, `prep`, `pyramid`, or `problem-solution`. Categories are free-form labels
+that can later drive filtering without changing the file layout.
+
+## YAML schema
+
+Each method file is a single YAML mapping:
+
+```yaml
+id: scqa
+name: SCQA
+category: narrative
+description: Situation, Complication, Question, Answer structure for building a clear business narrative.
+locale: en
+suitable_for:
+  - Strategy updates
+  - Problem-solving proposals
+slides:
+  - title: Situation
+    role: Establish the shared context the audience already recognizes.
+    instructions: Describe the current state with concrete facts.
+ai_instructions:
+  - Use the SCQA sequence exactly.
+review_checklist:
+  - Does the situation establish common ground?
+references:
+  - title: The Pyramid Principle
+    author: Barbara Minto
+```
+
+Required fields are `id`, `name`, `category`, `description`, `suitable_for`,
+`slides`, `ai_instructions`, and `review_checklist`. `references` and `locale` are
+optional; `locale` defaults to `en`. Every slide entry requires `title`, `role`, and
+`instructions`.
+
+## Ruby class design
+
+- `Slidict::PresentationMethod` represents one method definition.
+- `Slidict::MethodSlide` represents each slide role.
+- `Slidict::PresentationMethodRegistry` loads built-in YAML files and plugin YAML files.
+- `Slidict::Deck` accepts an optional `presentation_method` and turns method slide roles into a local template when `--no-llm` is used or no LLM is configured.
+
+Validation happens at load time with `YAML.safe_load_file`. Slidict checks required
+fields, requires lowercase method IDs (`a-z`, `0-9`, and `-`), and verifies that each
+slide role has the required fields.
+
+## CLI design
+
+- `--method ID` applies a method to generated slides.
+- `list-methods` prints every discovered method.
+- `show-method ID` prints a method's description, use cases, slide roles, and review checklist.
+
+## Plugin design
+
+External gems can distribute methods without changing Slidict itself. A plugin gem only
+needs to place YAML files under `lib/slidict/methods/*.yml` so RubyGems can expose them
+through `Gem.find_files`.
+
+Example plugin layout:
+
+```text
+slidict-methods-product/
+  lib/slidict/methods/product-demo.yml
+  slidict-methods-product.gemspec
+```
+
+After the plugin gem is installed, Slidict automatically includes those YAML files in
+`list-methods`, `show-method`, and `--method` lookup.
+
+## Future localization
+
+Method files include a `locale` field. The recommended future shape is one file per
+localized method, for example `scqa.en.yml` and `scqa.ja.yml`, with the same method ID
+plus locale-aware lookup. Keeping all user-facing text in YAML means translations can be
+reviewed independently from Ruby changes.
+
+## OSS contribution workflow
+
+To propose a new presentation method:
+
+1. Copy an existing YAML file in `data/slidict/methods/`.
+2. Change `id`, `name`, `category`, `description`, `suitable_for`, `slides`, `ai_instructions`, and `review_checklist`.
+3. Add `references` when useful.
+4. Run `bundle exec rspec` and `bundle exec rubocop`.
+5. Open a PR with the method file and a short explanation of the communication technique.

data/lib/slidict/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Slidict
-  VERSION = "0.5.0"
+  VERSION = "0.5.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slidict
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.2
 platform: ruby
 authors:
 - Yusuke Abe
@@ -75,6 +75,11 @@ files:
 - data/slidict/methods/prep.yml
 - data/slidict/methods/pyramid.yml
 - data/slidict/methods/scqa.yml
+- docs/demo-methods.gif
+- docs/demo-methods.tape
+- docs/demo.gif
+- docs/demo.tape
+- docs/presentation-methods.md
 - lib/slidict.rb
 - lib/slidict/cli/app.rb
 - lib/slidict/cli/lint.rb
@@ -94,13 +99,13 @@ files:
 - lib/slidict/output/renderer.rb
 - lib/slidict/presentation_method.rb
 - lib/slidict/version.rb
-homepage: https://labs.slidict.io/slidict/
+homepage: https://slidict.com
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://labs.slidict.io/slidict/
-  source_code_uri: https://github.com/slidict/slidict
-  changelog_uri: https://github.com/slidict/slidict/releases
+  homepage_uri: https://slidict.com
+  source_code_uri: https://github.com/slidict/slidict-cli
+  changelog_uri: https://github.com/slidict/slidict-cli/releases
 rdoc_options: []
 require_paths:
 - lib