feat: Review & improve documentation before release#212
Conversation
Signed-off-by: handreyrc <handrey.cunha@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
Documentation-focused PR to refresh project and package READMEs ahead of release, clarifying setup commands, monorepo structure, and package usage.
Changes:
- Expanded root
README.mdwith overview, quick-start, dev/test commands, and architecture/CI notes. - Updated package READMEs (
diagram-editor,i18n, and internalcore/react-flowdocs) with clearer structure and API/architecture descriptions. - Enhanced
CONTRIBUTING.mdwith updated stack/testing sections and Git hook/DCO guidance.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Adds project overview, quick start, dev workflow, stack/architecture, and CI/release/community sections. |
| CONTRIBUTING.md | Updates contributor guidance (stack, reporting, hooks/DCO, testing/CI). |
| packages/i18n/README.md | Rewrites as a package README with features, API reference, usage, and dev notes. |
| packages/serverless-workflow-diagram-editor/README.md | Updates to published package name, installation/usage, structure, and architecture principles. |
| packages/serverless-workflow-diagram-editor/src/core/README.md | Expands module-level documentation and SDK-isolation guidance for the core layer. |
| packages/serverless-workflow-diagram-editor/src/react-flow/README.md | Greatly expands React Flow directory documentation and responsibilities. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: handreyrc <handrey.cunha@gmail.com>
|
|
||
| Defines all custom node components for Serverless Workflow task types: | ||
|
|
||
| - **Terminal nodes**: `StartNode`, `EndNode`, `EntryNode`, `ExitNode` (compact pill shapes) |
There was a problem hiding this comment.
We should update this in prep for Adityas PR going in where start and end nodes are circles rather than pills
| ### Edge Types | ||
|
|
||
| - **Default**: Standard workflow transitions (solid line) | ||
| - **Error**: Exception/error flow from raise tasks (dashed red line with AlertTriangle icon) |
There was a problem hiding this comment.
I dont think the edge has an icon? Same for Condition, I dont think there is a icon associated with edge, think maybe just "dashed red line" and "blue line with dashed line for default switch case"?
| - **CSS target**: `src/components/ui/shadcn.css` — where shadcn injects its CSS variables | ||
| - **Path aliases**: `@/components`, `@/lib`, `@/hooks` — resolved via `tsconfig.json` paths and Vite's `tsconfigPaths` | ||
| - **Icon library**: `lucide` (generates `lucide-react` imports) | ||
| - **Tailwind prefix**: `dec:` — all generated classes prefixed to avoid conflicts |
There was a problem hiding this comment.
maybe add "to avoid conflicts with host applications"
|
@handreyrc Thanks for the PR, just added some small comments and if you could also update the storybook welcome page to replace the TODO, thanks |
fantonangeli
left a comment
fantonangeli
left a comment
There was a problem hiding this comment.
I only left one fix, but I would say there are a few docs here that we need to keep updated in the future.
| - The editor can be adapted to different rendering libraries if needed | ||
| - Platform-specific integrations (VS Code, browser extensions) don't become coupled to React Flow | ||
|
|
||
| ## Files and Their Purpose |
There was a problem hiding this comment.
@lornakelly @handreyrc here and in other READMEs, the documentation is nice and useful, but do we really need to add so many details in the documentation, which we will need to keep updated in the future.
I would say just a line on each file is ok, or a small documentation inside the files themselves.
Wdyt?
There was a problem hiding this comment.
Makes sense, like you say, just a general one liner as opposed to everything that the file holds
| - `ReactFlowNodeTypes`: Mapping of `GraphNodeType` to React components | ||
| - `BaseNodeData<T>`: Type definition for node data (label, task, hasError) | ||
|
|
||
| #### [`taskNodeConfig.ts`](taskNodeConfig.ts) |
There was a problem hiding this comment.
| #### [`taskNodeConfig.ts`](taskNodeConfig.ts) | |
| #### [`taskNodeConfig.ts`](nodes/taskNodeConfig.ts) |
|
|
||
| > This isn't about banning AI — it's about keeping this project collaborative, human-driven, and focused on quality. | ||
| ## Git Hooks |
There was a problem hiding this comment.
Git hooks are transparent to the contributors, unti they don't see an error, and they are implemented in the standard way.
I don't think a contributor needs this section.. but I let you decide
Closes: #195
Summary
This PR aims to review and update all *.md files in the project to reflect the latest code.
Changes
The following files where reviewed and updated