Missing results in search

[tzachshabtay]

DocFX Version Used: 2.23 (I think? Whatever is installed with chocolatey- would be useful to have the DocFX version in the footer of the default template)

Template used: default

Steps to Reproduce:

1. Build docs for this repo: https://github.com/tzachshabtay/MonoAGS (you can use the appveyor script at the root of the repo).
2. Go to the generated website (or, alternatively, look at the one already built: https://tzachshabtay.github.io/MonoAGS/api/AGS.API.html)
3. In the search bar, type "IWalk"

Expected Behavior:

Expecting to find IWalkableArea, IWalkBehindArea and IWalkBehavior as results, as I have those interfaces (and probably more results).

Actual Behavior:

No matches.

More Scenarios:

Type "Walk" -> Now I do see those interface in the results?
Type "WalkBehavior" -> I don't see IWalkBehavior
Type "IWalkBehavior" -> Now I do see IWalkBehavior
Type "Walkable" -> I can see IWalkableArea
Type "WalkableArea" -> And now I can't see IWalkableArea.

[mcurros]

I opened your generated docs site and it works for me in Edge. What browser are you using... ?

[tzachshabtay]

I'm using Chrome (and reproduced from both Windows 7 and a Mac).

Here's a screenshot:

[928PJY]

Hi, @tzachshabtay, you can use IWalk* to get your expected behavior

[tzachshabtay]

@928PJY You mean as a workaround? Or is this "by design"? Because if it's by design, then I don't understand the logic here.

[vwxyzh]

@tzachshabtay I think the reason is:

• We have inserted some zero width space in title for word break.
• For lunr, zero width space is same as space.
• The insert logic is: insert the zero width space for every word.
• So in title IWalkBehavior will be I Walk Behavior, so walk can match the whole word in title.
• But IWalk or WalkBehavior cannot match it.
• IWalkBehavior match some other word not in title.

[tzachshabtay]

I Didn't know zero width space was a thing.
Ok, so if I understand correctly, basically search is broken for all CamelCase words, right? Which is the vast majority of dot net APIs.

One silly suggestion, then (thinking out loud): would adding a zero width space to the search term (before sending it to lunr- i.e doing the same processing you do to the website text so the two texts will match) solve this? Or probably would create an issue because you probably don't add the zero width space to the articles, only to the API, so maybe splitting to 2 searches and combining afterwards, one untouched for the articles and one preprocessed for the APIs (maybe there's a simpler solution).

[tzachshabtay]

Hi, is it possible to expedite this? I keep getting complaints from users that they fail to find stuff in the docs because of this.

Thanks.

And here's an example of a missing search result even when I do use an asterisk:
Search for "ChangeRoom*", and see that this page is missing from the results: https://tzachshabtay.github.io/MonoAGS/api/AGS.API.ICharacter.html, even though ICharacter inherits from IHasRoomComponent which has "ChangeRoomAsync".

[superyyrrzz]

I have a look at what the keywords are extracted from this page. I found this IHasRoomComponent.ChangeRoomAsync(IRoom, Nullable<Single>, Nullable<Single>) is indexed, then search for *ChangeRoom* or IHasRoomComponent.ChangeRoomAsync(IRoom can make this page appear in the result.

More to investigate:

1. Can we extract ChangeRoomAsync into keywords? We should make lunr understand . as a separator.
2. , seems like a separator in index.json's keywords, which result in the strange IHasRoomComponent.ChangeRoomAsync(IRoom. It's like a bug when generate keywords.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in a week if no further activity occurs.

[tzachshabtay]

Still a critical issue, please do not delete.