Raku / doc-website

Tooling to build/run the documentation website
Artistic License 2.0
7 stars 10 forks source link

resolves #206 adding indexed info into search value #339

Closed finanalyst closed 7 months ago

finanalyst commented 7 months ago
coke commented 7 months ago

ref #206

finanalyst commented 7 months ago

@coke I dont understand.

However, the radix forms don't appear in the search at all.

The radix forms referred to in the issue, are referred to in the info section of a candidate, but you have to search for 'syntax', not '0b'. The same is true of all sorts of information that is in X<> markup that is included in headers, of the form =head1 X<this is a header|Foo;Include this in a composite>. The problem was that the Include this in a composite would be in the info section of a search candidate, and 'Foo' would be in the value. The search box is actually a filter that takes an array of candidate entry structures, and filters on the 'value' portion of the structure. So, this patch moved the data (include this ...) from info to value, and so makes it searchable.

I think this is a useful patch.

Sorry not to have been more explicit earlier.

coke commented 7 months ago

My comment above was just to have a clickable link to the ticket you mentioned in the title.

coke commented 7 months ago

Is this deployed at your copy of the site? A search for 0b still finds nothing. from your description above

So, this patch moved the data (include this ...) from info to value, and so makes it searchable.

I would have expected that to work now.

finanalyst commented 7 months ago

@coke Yes, it is working on new-raku. However, you do need to enable searching of Indexed information. Click on the gears icon to the left of search, enable 'Indexed', then search for 0b or 0x By default, 'Indexed' search is disabled. This was because it was broken when the site went live. Now it works quite well.

coke commented 7 months ago

Verified that if I toggle that option, I can search for 0b.

Should we now make that option the default?