Skip to content

feat: Update README files with folder structure#93

Merged
ricardozanini merged 3 commits intoserverlessworkflow:mainfrom
lornakelly:9/readme-updates
Apr 16, 2026
Merged

feat: Update README files with folder structure#93
ricardozanini merged 3 commits intoserverlessworkflow:mainfrom
lornakelly:9/readme-updates

Conversation

@lornakelly
Copy link
Copy Markdown
Contributor

Closes
#9

Summary

Added structure documentation to both the root README and the serverless-workflow-diagram-editor package README to help contributors understand the repository organisation and locate key components.

Changes:

  • Root README: Added "Repository Structure" documenting top-level folder structure with inline comments
  • Root README: Added "Key Packages" section with detailed descriptions
  • Package README: Added "Package Structure" documenting folder structure with inline comments

Copilot AI review requested due to automatic review settings April 15, 2026 09:20
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds repository/package structure documentation to help contributors navigate the monorepo and locate key components, addressing issue #9.

Changes:

  • Added a top-level “Repository Structure” section to the root README.
  • Added a “Key Packages” overview to the root README.
  • Added a “Package Structure” section to the serverless-workflow-diagram-editor package README.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
README.md Documents top-level folder layout and provides a brief overview of key packages.
packages/serverless-workflow-diagram-editor/README.md Documents the package folder structure for contributors working in the diagram editor package.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread packages/serverless-workflow-diagram-editor/README.md Outdated
Comment thread packages/serverless-workflow-diagram-editor/README.md Outdated
Copy link
Copy Markdown
Member

@fantonangeli fantonangeli left a comment

Choose a reason for hiding this comment

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

Approving because my comments are minor suggestions.

Comment thread README.md
Comment thread README.md
Copy link
Copy Markdown
Contributor

@kumaradityaraj kumaradityaraj left a comment

Choose a reason for hiding this comment

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

LGTM

Copilot AI review requested due to automatic review settings April 16, 2026 12:26
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread packages/serverless-workflow-diagram-editor/README.md Outdated
Copilot AI review requested due to automatic review settings April 16, 2026 12:31
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md
Comment thread README.md
lornakelly and others added 3 commits April 16, 2026 13:43
Signed-off-by: Lorna Kelly <lornakelly88@gmail.com>
Signed-off-by: Lorna-Kelly <lornakelly88@gmail.com>
Signed-off-by: Lorna-Kelly <lornakelly88@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Lorna-Kelly <lornakelly88@gmail.com>
@ricardozanini ricardozanini merged commit bb8e0fd into serverlessworkflow:main Apr 16, 2026
5 checks passed
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.

5 participants