Fix FAQ Broken Links #21
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR fixes broken FAQ links by adding HTML anchor elements to FAQ section headers. The fix ensures that direct links to specific FAQ questions will properly navigate to the correct sections on the page.
- Added HTML anchor elements with unique IDs to 20 FAQ section headers
- Implemented CSS styling to position anchors above the fixed navigation header
- Added basic README documentation for the project
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| faqs.mdx | Added anchor elements with descriptive IDs to FAQ section headers for proper link navigation |
| style.css | Added CSS rules to position anchor elements correctly with fixed header offset |
| README.md | Added project documentation with local development instructions |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| a[id] { | ||
| display: block; | ||
| position: relative; | ||
| top: -80px; | ||
| visibility: hidden; | ||
| } |
There was a problem hiding this comment.
The magic number -80px should be defined as a CSS custom property or variable to make it easier to maintain if the header height changes. Consider using --header-offset: 80px and referencing it as top: calc(var(--header-offset) * -1).
| ## Testing | ||
|
|
||
| <a id="how-should-i-test-radar-battery-drain"></a> | ||
| ### How should I test Radar battery drain? |
There was a problem hiding this comment.
This is done because Mintlify adds the ? to the href, unfortunately Mintlify search doesn’t append the ? to the search
ie this works
https://docs.radar.com/faqs#can-i-test-radar-side-by-side-with-another-location-sdk%3F
while this bottom link doesn’t
https://docs.radar.com/faqs#can-i-test-radar-side-by-side-with-another-location-sdk
Before Docusaurus automatically removes the ?
https://documentation-radar.vercel.app/faqs#how-should-i-test-radar-battery-drain
I’m going to assume Docusaurus is closer to the implementation we want as the ? is pressumably removed for query parameters.
I tried looking at mintlify docs such that we can strip the ? while routing but doesn’t look like it exist. This is probably the easiest solution but it’s a little tacky so I’m open to other ideas
1 participant
No description provided.