feat: Review & improve documentation before release#212
Merged
ricardozanini merged 8 commits intoJul 6, 2026
Merged
Conversation
✅ Deploy Preview for swf-editor ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
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.
lornakelly
reviewed
Jul 1, 2026
Contributor
|
@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
reviewed
Jul 1, 2026
fantonangeli
left a comment
fantonangeli
left a comment
Member
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.
Signed-off-by: handreyrc <handrey.cunha@gmail.com>
Signed-off-by: handreyrc <handrey.cunha@gmail.com>
Signed-off-by: handreyrc <handrey.cunha@gmail.com>
handreyrc
force-pushed
the
update-documentation
branch
from
f252e9a to
4dede19
Compare
Signed-off-by: handreyrc <handrey.cunha@gmail.com>
kumaradityaraj
approved these changes
Jul 6, 2026
Signed-off-by: handreyrc <handrey.cunha@gmail.com>
Signed-off-by: handreyrc <handrey.cunha@gmail.com>
Contributor
Author
|
I updated the storybook welcome page so we don't have that TODO there anymore. Thanks! |
lornakelly
reviewed
Jul 6, 2026
Signed-off-by: handreyrc <handrey.cunha@gmail.com>
Signed-off-by: handreyrc <handrey.cunha@gmail.com>
fantonangeli
approved these changes
Jul 6, 2026
Contributor
Author
|
If you have no futrher considerations this PR should be good enough to be merged. Thanks! |
ricardozanini
merged commit 5f3a5d7
into
open-workflow-specification:main
12 checks passed
6 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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