docs: improvements + additions to workflow docs

[shahednasser]

Improve existing workflow docs + add missing docs

[vercel]

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	Sep 20, 2024 3:29pm
api-reference-v2	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Sep 20, 2024 3:29pm
docs-ui	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Sep 20, 2024 3:29pm
docs-v2	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Sep 20, 2024 3:29pm
medusa-dashboard	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Sep 20, 2024 3:29pm
resources-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Sep 20, 2024 3:29pm

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
medusa-docs	⬜️ Ignored (Inspect)	Visit Preview		Sep 20, 2024 3:29pm

[changeset-bot]

⚠️ No Changeset found

Latest commit: 63d3d94

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

[kodiakhq]

This PR currently has a merge conflict. Please resolve this and then re-add the automerge label.

[olivermrbl]

Nice work, added a single comment but otherwise LGTM

[olivermrbl]

thought: Given we currently have so few API Routes that accept additional data, I think we should do one of two things:

1. Add the list of all API Routes and reference it here
2. Hide this for the time being

The reason I suggest 2. is that we need admin extensions before this is really useful.

[shahednasser]

Add the list of all API Routes and reference it here

Cool idea, I'll do this manually for now but probably worth looking into generating this info (can look into it at another point)

Hide this documentation for the time being

We already use this in the new Customizations chapter 😄 What do you think of adding a note that says you'll be benefit more from this once we add admin extensions soon? (or do we not want to mention it?) Either way, I believe it's generally fine to keep.