Skip to content

docs: add contributor and scenario guidance - #18

Merged
bnquon merged 3 commits into
mainfrom
feat/project-docs
Aug 29, 2026
Merged

docs: add contributor and scenario guidance#18
bnquon merged 3 commits into
mainfrom
feat/project-docs

Conversation

@bnquon

@bnquon bnquon commented Aug 29, 2026

Copy link
Copy Markdown
Owner

Summary

This PR gives Orson a clearer contributor and scenario-documentation surface as the project moves beyond its initial MVP planning phase.

What changed

  • Replaced the original milestone-heavy roadmap with a concise directional roadmap. It explicitly states that priorities are flexible and not strictly followed.
  • Added CONTRIBUTING.md with local setup, demo Kafka instructions, scenario guidelines, branch conventions, validation commands, and PR expectations.
  • Added a canonical scenario-format guide and scenario examples index, while keeping scenarios/order-flow.yaml as the complete bundled example.
  • Added a PR template without a checklist.
  • Added structured GitHub bug-report and feature-request forms.
  • Added a Scenario Browser info button with an accessible YAML guide modal and copyable compact example.
  • Tightened README links so the new documentation is discoverable.

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 check
  • npm run test:frontend
  • npm --prefix frontend run build
  • git diff --check

Notes

The modal intentionally does not include an Open example action. The full canonical example remains in scenarios/order-flow.yaml, with the detailed reference in docs/scenario-format.md.

@pullfrog pullfrog Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Pullfrog  | Fix all ➔Fix 👍s ➔View workflow run | Using GPT Luna𝕏

Comment thread CONTRIBUTING.md Outdated
Comment thread frontend/src/features/workbench/components/ScenarioGuideModal.tsx Outdated

@pullfrog pullfrog Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ℹ️ 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/CODEOWNERS rule assigning the default owner for repository changes.

Pullfrog  | Fix it ➔View workflow run | Using GPT Luna𝕏

@pullfrog pullfrog Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ 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+ or 22.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.

Pullfrog  | View workflow run | Using GPT Luna𝕏

@bnquon
bnquon merged commit 45ce89f into main Aug 29, 2026
4 checks passed
@bnquon
bnquon deleted the feat/project-docs branch August 29, 2026 20:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant