docs: add contributor and scenario guidance - #18
Conversation
There was a problem hiding this comment.
Important
Please correct the contributor prerequisite and the scenario guide's topology contract before merging.
Reviewed changes This review covers the contributor and scenario documentation, repository templates, README and roadmap updates, Scenario Browser guide modal, styling, and interaction tests.
- Contributor guidance — Reviewed local setup, demo startup, validation commands, branch conventions, and pull request expectations.
- Scenario guidance — Reviewed the YAML format reference, bundled examples index, and modal's copyable example.
- Scenario Browser guide — Reviewed the new trigger, modal behavior, styling, accessibility attributes, and frontend tests.
GPT Luna | 𝕏
There was a problem hiding this comment.
ℹ️ No new issues found in this incremental delta. The prior review findings remain open.
Reviewed changes This incremental review covers the repository ownership configuration added since the prior Pullfrog review.
- Repository ownership — Added a wildcard
.github/CODEOWNERSrule assigning the default owner for repository changes.
GPT Luna | 𝕏
There was a problem hiding this comment.
✅ No new issues found.
Reviewed changes This incremental review covers the setup and topology guidance changes since the prior Pullfrog review.
- Clarified prerequisites — Documented Node.js
20.19+or22.12+, matching the locked frontend toolchain. - Corrected topology guidance — Explained that disconnected watched-topic components remain capturable while only connected topics appear connected to the root graph.
- Updated interaction coverage — Adjusted the Scenario Browser guide assertions to reflect the clarified topology contract.
GPT Luna | 𝕏

Summary
This PR gives Orson a clearer contributor and scenario-documentation surface as the project moves beyond its initial MVP planning phase.
What changed
CONTRIBUTING.mdwith local setup, demo Kafka instructions, scenario guidelines, branch conventions, validation commands, and PR expectations.scenarios/order-flow.yamlas the complete bundled example.User-facing behavior
Users can open the scenario guide from the Scenario Browser header to understand the YAML structure, watched topics, topology edges, and correlation settings. They can copy a valid compact example without leaving the app.
Validation
npm run checknpm run test:frontendnpm --prefix frontend run buildgit diff --checkNotes
The modal intentionally does not include an Open example action. The full canonical example remains in
scenarios/order-flow.yaml, with the detailed reference indocs/scenario-format.md.