Repository navigation
Make the first run work without API keys or external tools - #31
Merged
Merged
Conversation
There was a problem hiding this comment.
🟡 Changes recommended
The newly added demo-first sections in all doc locales can be misread as working with a package-only install despite requiring a repository checkout, so the wording should be clarified to avoid confusing first-time users.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR adds a fully local “first run” demo pipeline (no API keys or external tooling) and makes it the primary quickstart path, backed by a new test to ensure the shipped demo can run, resume from persisted state, and generate reports.
Changes:
- Added a
pipelines/demopipeline and two harmless text samples to demonstrate discovery, filtering, resumable runs, and report generation offline. - Updated README + all documentation locales to surface the demo as the recommended first run, and refreshed the documented CI Python versions.
- Added an end-to-end pytest that runs the demo via the CLI, asserts expected filtering behavior, verifies resume semantics, and checks report outputs.
File summaries
| File | Description |
|---|---|
| tests/test_demo.py | Adds an end-to-end CLI test for the shipped demo pipeline (run/resume/report). |
| README.md | Reworks Quickstart to use the local demo first; updates repo structure and CI Python version notes. |
| pipelines/demo/pipeline.yaml | Defines the minimal built-in demo pipeline (file discovery + metadata filter). |
| pipelines/demo/README.md | Documents expected demo behavior and how to experiment with the pipeline locally. |
| pipelines/demo/samples/hello.txt | Adds the “kept” sample that passes the size filter. |
| pipelines/demo/samples/tiny.txt | Adds the “filtered” sample that fails the size filter. |
| docs/en/overview/quickstart.md | Adds “Try the local demo first” section to the English quickstart. |
| docs/es/overview/quickstart.md | Adds the demo-first section to the Spanish quickstart. |
| docs/fr/overview/quickstart.md | Adds the demo-first section to the French quickstart. |
| docs/ja/overview/quickstart.md | Adds the demo-first section to the Japanese quickstart. |
| docs/ru/overview/quickstart.md | Adds the demo-first section to the Russian quickstart. |
| docs/zh-CN/overview/quickstart.md | Adds the demo-first section to the Simplified Chinese quickstart. |
Review details
- Files reviewed: 12/12 changed files
- Comments generated: 6
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
|
||
| ### Try the local demo first | ||
|
|
||
| After installing the base package, run the included harmless text samples from the repository root: |
|
|
||
| ### Try the local demo first | ||
|
|
||
| After installing the base package, run the included harmless text samples from the repository root: |
|
|
||
| ### Try the local demo first | ||
|
|
||
| After installing the base package, run the included harmless text samples from the repository root: |
|
|
||
| ### Try the local demo first | ||
|
|
||
| After installing the base package, run the included harmless text samples from the repository root: |
|
|
||
| ### Try the local demo first | ||
|
|
||
| After installing the base package, run the included harmless text samples from the repository root: |
|
|
||
| ### Try the local demo first | ||
|
|
||
| After installing the base package, run the included harmless text samples from the repository root: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem and change
The quickstart requires a driver corpus and external analysis tooling before a new user can see the engine work. Add a local demo using two harmless text samples and built-in discovery/filter processors, then make it the README's first run. Users can inspect a report and resume saved results without API keys or external analysis tools.
Include the demo instructions in all six documentation locales, preserving existing translations and using English for the new section as CONTRIBUTING.md permits. Add a modest star/feedback invitation and correct the documented CI Python versions.
Validation
pytest -m "not ghidra": 359 passed, 1 skipped, 1 deselected.git diff --checkpassed.