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: improvements to API reference intro sections #9397

Merged
merged 2 commits into from
Oct 6, 2024
Merged

docs: improvements to API reference intro sections #9397

merged 2 commits into from
Oct 6, 2024

Conversation

shahednasser
Copy link
Member

@shahednasser shahednasser commented Oct 1, 2024 •
edited
Loading

  • Improve intro sections of API reference to utilize divided columns
  • Improve the content of the intro sections
  • Add a new Workflows section to explain the workflows badge and how to use it
  • Fixes to headings and add anchor for copying the link to a section
  • Fixes responsiveness of intro sections on mobile devices
  • Other: fix loading not showing when a sidebar category is opened.

Closes DOCS-932, DOCS-934, DOCS-937

Preview: https://api-reference-v2-git-docs-api-ref-intro-fixes-medusajs.vercel.app/v2/api/store

@shahednasser shahednasser requested a review from a team as a code owner October 1, 2024 08:38
@vercel Vercel
Copy link

vercel bot commented Oct 1, 2024 •
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 Oct 1, 2024 8:55am
api-reference-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 1, 2024 8:55am
docs-ui ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 1, 2024 8:55am
docs-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 1, 2024 8:55am
medusa-dashboard ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 1, 2024 8:55am
resources-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 1, 2024 8:55am
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
medusa-docs ⬜️ Ignored (Inspect) Visit Preview Oct 1, 2024 8:55am

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Oct 1, 2024 •
edited
Loading

⚠️ No Changeset found

Latest commit: 261d578

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

olivermrbl
olivermrbl approved these changes Oct 6, 2024
View reviewed changes
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.

Nice improvements!

@kodiakhq kodiakhq bot merged commit 522d3ce into develop Oct 6, 2024
32 checks passed
@kodiakhq kodiakhq bot deleted the docs/api-ref-intro-fixes branch October 6, 2024 16:51
panalgin pushed a commit to vennyx-org/medusa that referenced this pull request Oct 7, 2024
@shahednasser @panalgin
docs: improvements to API reference intro sections (medusajs#9397)
f89dc69 
- Improve intro sections of API reference to utilize divided columns
- Improve the content of the intro sections
- Add a new Workflows section to explain the workflows badge and how to use it
- Fixes to headings and add anchor for copying the link to a section
- Fixes responsiveness of intro sections on mobile devices
- Other: fix loading not showing when a sidebar category is opened.

Closes DOCS-932, DOCS-934, DOCS-937

Preview: https://api-reference-v2-git-docs-api-ref-intro-fixes-medusajs.vercel.app/v2/api/store
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@olivermrbl olivermrbl olivermrbl approved these changes

Assignees
No one assigned
Labels
automerge team: medusa type: docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@shahednasser @olivermrbl