Quick navigation in DocC Render

Thanks for the feedback @beatriz!

You’ve touched on one of the most challenging parts of this project. I agree with @daniel-grumberg that there’s no perfect standard right now. My advice is that whatever logic you end up picking should feel predictable and consistent to users.

I found that fuzzy search uses an algorithm to calculate the relevance of exact and partial matching string similarity = 1 - (edit_distance / min (len(term), len(word))) where edit_distance is calculated using the Levenshtein Distance algorithm, but as I mentioned to @daniel-grumberg this is probably over-engineering the solution that could end up affecting the website performance, so maybe there's a simple way of achieving this

How are you thinking about discoverability of this feature? How should users know it’s there and how to access it?

What I'm thinking regarding this is using the same command that is used to activate "Open Quickly" in Xcode ⌘ + shift + o. The reason why this might solve the discoverability issue relies on Jakob’s Law which states that "Users spend most of their time on other sites. This means that users prefer your site to work the same way as all the other sites they already know", if the user comes from developing in Xcode there's a big chance they will expect the same search functionality by pressing the same keyboard shortcut. Other options are to add a magnifier glass icon on the top right of the screen that triggers the modal on click like the one at Nuxt website, or implement what @Paulo_Faria suggested, a cheat sheet with all the website shortcuts.

Right now, the UI looks very similar to native Mac and Xcode’s. This might be confusing, could be worth exploring making it more visually different. I know you’re at the early stages of design, but I noticed the text and background doesn’t have enough contrast right now. If you’re curious, I typically use this contrast checker to verify the colors are accessible

Is great that you point this out bc I was designing it as similar to the native Mac search bar as possible, also thanks for the resource, I found that the codebase has its own color schema so I'm using those as a guide, I will do another iteration on the design and make it match as much as possible to the website, will share it over here once I have it.