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: DX and performance improvements in API reference #9430

Merged
merged 5 commits into from
Oct 2, 2024
Merged

docs: DX and performance improvements in API reference #9430

merged 5 commits into from
Oct 2, 2024

Conversation

shahednasser
Copy link
Member

  • Improve scroll behavior between active sections
  • Improve lag when clicking on a sidebar item
  • Refactor internal working of the SidebarProvider to find active items faster.
  • Use Next.js's useRouter hook for changing the hash (since they added the option to disable scroll)
  • Change isBrowser from a hook to a provider since it's widely used across applications.
  • Other general improvements and fixes.

Closes DOCS-952

@shahednasser shahednasser requested a review from a team as a code owner October 2, 2024 13:59
@changeset-bot changeset-bot
Copy link

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

⚠️ No Changeset found

Latest commit: 27b6e66

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

@vercel Vercel
Copy link

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

@kodiakhq kodiakhq bot merged commit 0f6f56e into develop Oct 2, 2024
32 checks passed
@kodiakhq kodiakhq bot deleted the docs/perf-improv branch October 2, 2024 15:51
panalgin pushed a commit to vennyx-org/medusa that referenced this pull request Oct 7, 2024
@shahednasser @panalgin
docs: DX and performance improvements in API reference (medusajs#9430)
4ed88d1 
- Improve scroll behavior between active sections
- Improve lag when clicking on a sidebar item
- Refactor internal working of the `SidebarProvider` to find active items faster.
- Use Next.js's `useRouter` hook for changing the hash (since they added the option to disable scroll)
- Change `isBrowser` from a hook to a provider since it's widely used across applications.
- Other general improvements and fixes.

Closes DOCS-952
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