sentry-docs icon indicating copy to clipboard operation
sentry-docs copied to clipboard

Incorrect linking and current page not highlighted in left nav

Open imatwawana opened this issue 3 years ago • 4 comments

Core or SDK?

Core Sentry product

Which part? Which one?

API Reference > Requests

Description

There are two problems described in the video that occur when you navigate directly by URL to any of the first five pages docs.sentry.io/api/ (not the ones under Endpoints). These are: Authentication, Paginating Results, Permissions & Scopes, Rate Limits, Requests.

  1. Once on one of the pages above, hover over any of the links in the left side nav under Endpoints, the URLs are all pointing to the pages under docs.sentry.io/product/data-management-settings/. If you navigate based on going to Docs and then clicking on links in the navigation however, then the URLs on hover are correct.

  2. When you navigate to one of these five pages this way, the current page isn't highlighted in the left side nav.

See video for what was originally reported: https://www.loom.com/share/cd6f494da5c04f1e89cec814fcf19e5b

Suggested Solution

The first is a known linking issue where the system seems to be caching other page information similar to #4915 . We haven't yet found a resolution to this, but when that's resolved, this issue will likely be resolved. The second issue is likely related, though this is the first time we're seeing it.

imatwawana avatar Oct 05 '22 18:10 imatwawana

Related to: #4580 #4915 #5453 #5453

imatwawana avatar Oct 07 '22 16:10 imatwawana

Hi, is this up for Hacktoberfest contributions?

Neeleshrj avatar Oct 10 '22 04:10 Neeleshrj

Hi @Neeleshrj - I wouldn't recommend this issue as one for Hacktoberfest. We've had someone who has a lot of experience with this repo work on it already without success, and we think it's going to need dedicated resources for a while.

Below are some issues that are also about improving/fixing our docs infrastructure that you might want to work on instead (I haven't linked these issues because I don't want them to appear as if they're related to this one):

  • 3497 - Dark mode missing from docs.sentry.io
  • 4358 - Layer ARN selector is broken
  • 4593 - Top page nav disappears on mobile
  • 4824 - Table doesn't resize properly

You can find more like these if you search for issues with the bug or enhancement labels. Of course, you're still welcome to work on this issue, but I wanted to give you some other options.

imatwawana avatar Oct 11 '22 19:10 imatwawana

Got it, Thanks!

Neeleshrj avatar Oct 15 '22 06:10 Neeleshrj

Was most likely solved by the migration to Next.js

stephanie-anderson avatar Feb 21 '24 13:02 stephanie-anderson