Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs-util: add support for workflows in markdown theme #8485

Merged
merged 17 commits into from
Aug 9, 2024

Conversation

shahednasser
Copy link
Member

@shahednasser shahednasser commented Aug 7, 2024

This PR adds support for displaying workflows and their diagrams in the markdown theme used when generating references. It also makes changes to docs-ui and typedoc-plugin-workflows.

Changes

Markdown Theme

  • Detect workflows to show in a workflow's reference its diagram, input, output, and hooks details.

typedoc-plugin-workflows

  • Add support for parallelize and when when picking up steps.

docs-ui

Stole and adapted the workflows execution canvas from the admin to show a diagram of the workflow's steps.


Demo

The references aren't generated in this PR so they aren't viewable in the preview.

General

This isn't shown in the video, but clicking on a step takes you to its own reference, and clicking on a hook takes you to its section within the same workflow's reference.

Screen.Recording.2024-08-07.at.3.54.31.PM.mov

Steps in When condition

Screenshot 2024-08-07 at 3 55 50 PM


Next Steps

  • Workflow inputs and steps that aren't exported in core-flows can't be generated in the reference. So, I'll open a PR to export them (If the file changes are big I'll open PRs in chunks)
  • Separate workflows and steps into namespaces to show them in the main reference / sidebar under "Workflows" and "Steps"
  • Add TSDocs for the workflows, inputs, etc... for better explanations and examples. This isn't a high priority at the moment.

Closes DOCS-862

Copy link

vercel bot commented Aug 7, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
medusa-dashboard ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 9, 2024 0:48am
6 Skipped Deployments
Name Status Preview Comments Updated (UTC)
api-reference ⬜️ Ignored (Inspect) Aug 9, 2024 0:48am
api-reference-v2 ⬜️ Ignored (Inspect) Visit Preview Aug 9, 2024 0:48am
docs-ui ⬜️ Ignored (Inspect) Visit Preview Aug 9, 2024 0:48am
docs-v2 ⬜️ Ignored (Inspect) Visit Preview Aug 9, 2024 0:48am
medusa-docs ⬜️ Ignored (Inspect) Visit Preview Aug 9, 2024 0:48am
resources-docs ⬜️ Ignored (Inspect) Visit Preview Aug 9, 2024 0:48am

Copy link

changeset-bot bot commented Aug 7, 2024

⚠️ No Changeset found

Latest commit: 51bd4b0

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@shahednasser shahednasser marked this pull request as ready for review August 7, 2024 13:03
@shahednasser shahednasser requested a review from a team as a code owner August 7, 2024 13:03
Copy link
Contributor

@olivermrbl olivermrbl left a comment

Choose a reason for hiding this comment

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

🚢 🚢 🚢

@thetutlage
Copy link
Contributor

Wow! This looks so cool :)

@shahednasser shahednasser merged commit a19c562 into develop Aug 9, 2024
31 checks passed
@shahednasser shahednasser deleted the docs-util/workflow-ref-theme branch August 9, 2024 13:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants