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.

Sign up for GitHub

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

Jump to bottom

docs: fixes for core workflows reference #11056

Merged
merged 5 commits into from
Jan 20, 2025
Merged

docs: fixes for core workflows reference #11056

merged 5 commits into from
Jan 20, 2025

Conversation

shahednasser
Copy link
Member

  • Fix generated example for array types
  • Fix description of step input / output not showing
  • Show summary in workflow diagram instead of entire description
  • Hide types if undefined, void, or never.

Closes DX-1298 and DX-1292

@shahednasser shahednasser requested a review from a team as a code owner January 20, 2025 15:02
@vercel Vercel
Copy link

vercel bot commented Jan 20, 2025 •
edited
Loading

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

Name Status Preview Comments Updated (UTC)
api-reference 🔄 Building (Inspect) Visit Preview 💬 Add feedback Jan 20, 2025 3:19pm
api-reference-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 20, 2025 3:19pm
docs-ui ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 20, 2025 3:19pm
docs-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 20, 2025 3:19pm
medusa-dashboard ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 20, 2025 3:19pm
resources-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 20, 2025 3:19pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
medusa-docs ⬜️ Ignored (Inspect) Visit Preview Jan 20, 2025 3:19pm

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Jan 20, 2025

⚠️ No Changeset found

Latest commit: babc5fb

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 merged commit 0d18d58 into develop Jan 20, 2025
32 checks passed
@shahednasser shahednasser deleted the docs/fix-step-type-desc branch January 20, 2025 15:34
noubase pushed a commit to noubase/medusa that referenced this pull request Jan 22, 2025
@shahednasser @noubase
docs: fixes for core workflows reference (medusajs#11056)
65f379e 
* docs: fix step input / output description not showing

* fix generated example for array types

* show workflow summary in diagram

* fix workflow node width

* hide undefined types
jimrarras pushed a commit to jimrarras/medusa that referenced this pull request Jan 28, 2025
@shahednasser @jimrarras
docs: fixes for core workflows reference (medusajs#11056)
09b64c4 
* docs: fix step input / output description not showing

* fix generated example for array types

* show workflow summary in diagram

* fix workflow node width

* hide undefined types
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
team: medusa type: docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@shahednasser