fix #90 - feat: Write integrator documentation#216
Conversation
Signed-off-by: fantonangeli <fabrizio.antonangeli@gmail.com>
✅ Deploy Preview for swf-editor ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
Adds integrator-facing documentation so consumers can install and embed the @serverlessworkflow/diagram-editor React component, with the repo README linking to the package-level “Getting Started” guide.
Changes:
- Add a top-level “Getting Started” section in the root README linking to the package docs.
- Add package-level “Getting Started” docs including React peer requirements, installation commands, a usage example, and a props table.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Adds a “Getting Started” section that points integrators to the package documentation. |
| packages/serverless-workflow-diagram-editor/README.md | Introduces integrator documentation (requirements, install, usage example, and props). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: fantonangeli <fabrizio.antonangeli@gmail.com>
fantonangeli
requested review from
cheryl7114,
handreyrc,
kumaradityaraj,
lornakelly and
ricardozanini
| | `locale` | `'en' \| 'fr'` | Yes | `'en'` | Language locale for the editor UI | | ||
| | `colorMode` | `'light' \| 'dark' \| 'system'` | No | `'system'` | Color theme for the editor | | ||
|
|
||
|
|
There was a problem hiding this comment.
Worth adding a section on adding a thin web component wrapper for non react applications?
There was a problem hiding this comment.
@lornakelly I would avoid making this README too big and complex and keep it focused on the basic React integration.
I think we can provide a non-React host example, under a new /examples dir, wrapping the DiagramEditor in a Web Component.
I can create a separate issue for this. Wdyt?
There was a problem hiding this comment.
Yes, thats a great idea, please create separate issue, thanks!
…-integrator-documentation Signed-off-by: fantonangeli <fabrizio.antonangeli@gmail.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
Comments suppressed due to low confidence (1)
packages/serverless-workflow-diagram-editor/README.md:97
- This README now has two installation sections (the new “Getting Started > Installation” plus the existing “## Installation”), duplicating the same commands. This increases the chance the docs drift; consider keeping a single source of truth and linking to it.
## Installation
```bash
npm install @serverlessworkflow/diagram-editor
# or
pnpm add @serverlessworkflow/diagram-editor
# or
yarn add @serverlessworkflow/diagram-editor
Import the component and styles:
import { DiagramEditor } from "@serverlessworkflow/diagram-editor";
import "@serverlessworkflow/diagram-editor/styles.css";</details>
|
@lornakelly there were of some conflicts with @handreyrc PR #212 . I had to change a few things in the last merge commit |
Signed-off-by: fantonangeli <fabrizio.antonangeli@gmail.com>
Signed-off-by: fantonangeli <fabrizio.antonangeli@gmail.com>
Signed-off-by: fantonangeli <fabrizio.antonangeli@gmail.com>
Signed-off-by: fantonangeli <fabrizio.antonangeli@gmail.com>
|
@ricardozanini Can you please merge this? |
ricardozanini
merged commit f7aa10d
into
open-workflow-specification:main
Closes #90
Description
Write integrator documentation covering how to install the npm package, embed the editor component, and provide workflow content to it. This should give consumers enough guidance to get started with setup and usage.
Motivation
Make it easier for integrators to adopt the editor by providing clear guidance on installation and implementation.
Proposed Implementation
No response
Definition of Done