Skip to content

Embed the new OWS Editor into the website - #10

Closed
kumaradityaraj wants to merge 6 commits into
open-workflow-specification:mainfrom
kumaradityaraj:owsEditor
Closed

Embed the new OWS Editor into the website#10
kumaradityaraj wants to merge 6 commits into
open-workflow-specification:mainfrom
kumaradityaraj:owsEditor

Conversation

@kumaradityaraj

Copy link
Copy Markdown

closes #5

Overview

This PR adds support for embedding the Workflow Editor directly into a webpage, allowing the editor to be integrated and rendered as part of an existing web application.

  • Integrated the editor into a webpage/container without requiring the standalone editor application.

Screenshots

Screenshot 2026-08-25 at 12 46 18 PM

Signed-off-by: kumaradityaraj <sedulous.0007@gmail.com>
@netlify

netlify Bot commented Aug 25, 2026

Copy link
Copy Markdown

Deploy Preview for openworkflow ready!

Name Link
🔨 Latest commit 045589d
🔍 Latest deploy log https://app.netlify.com/projects/openworkflow/deploys/6a8ebb219e88310008dc6134
😎 Deploy Preview https://deploy-preview-10--openworkflow.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Signed-off-by: kumaradityaraj <sedulous.0007@gmail.com>
Signed-off-by: kumaradityaraj <sedulous.0007@gmail.com>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

This PR integrates the Open Workflow Specification (OWS) Diagram Editor into the website’s landing-page examples section, rendering a visual workflow preview alongside each YAML example.

Changes:

  • Added a React-based OWSEditor component that wraps @openworkflowspec/diagram-editor.
  • Updated the homepage examples tab UI to show YAML and the embedded editor side-by-side, plus a small tab-change script to trigger “fit view”.
  • Added Astro React integration + React/ReactDOM dependencies and adjusted TS config for JSX.

Reviewed changes

Copilot reviewed 5 out of 10 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
tsconfig.json Enables React JSX compilation settings needed for .tsx components.
src/pages/index.astro Embeds the editor next to examples and adds a tab-change script; also includes large formatting/structural changes.
src/components/OWSEditor.tsx Introduces the React wrapper around DiagramEditor.
package.json Adds React + Astro React integration + diagram editor dependencies.
astro.config.mjs Registers the @astrojs/react integration.
.nvmrc Updates the Node version used for local/dev tooling.
.gitignore Modifies JetBrains ignore behavior (currently in a problematic way).

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread src/pages/index.astro
Comment thread src/components/OWSEditor.tsx Outdated
Comment thread package.json
@lornakelly

lornakelly commented Aug 25, 2026

Copy link
Copy Markdown
Contributor

@kumaradityaraj Thanks for the PR, it looks really nice and will be great to promote the editor as well.

Co pilot has a few comments to address and I added a few more. Will wait to review the index.astro until after the current suggested changes

A few other things:

  • The website has a light and dark theme that the editor should follow, at the moment it is displaying light in both modes
  • A few of the examples are invalid, the example files might need to be updated to be in line with the specification change so we dont have any invalid examples (a good improvement highlighted by this PR)
  • It would good to have somewhere close to the editor a link to npm package to encourage people to install and try it themselves
  • If you could review the files as well, a few are missing new lines at the end

Comment thread pnpm-lock.yaml Outdated
Comment thread src/components/OWSEditor.tsx
Comment thread src/pages/index.astro
Comment thread .nvmrc Outdated
Comment thread tsconfig.json Outdated
Comment thread .gitignore Outdated
Signed-off-by: kumaradityaraj <sedulous.0007@gmail.com>
Signed-off-by: kumaradityaraj <sedulous.0007@gmail.com>
Signed-off-by: kumaradityaraj <sedulous.0007@gmail.com>
@kumaradityaraj

Copy link
Copy Markdown
Author

This PR is opened again here - #11

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.

Embed the new OWS Editor into the website

3 participants