jolt-lang / jolt-lang/jolt-lang.github.io
Optimizing client-side search weighting
- Dominant language
- CSS
- Stars
- 0
- Forks
- 2
- Avg merge
- 12h 10m
- Merged PRs (30d)
- 15
Description
Follow up on https://github.com/jolt-lang/jolt-lang.github.io/issues/34
Testing the search functionality typing search query "interop", the weighting might have some room for improvement, while there's no critical issue and the index seems quite complete.
## `in`
- [Host Interop > Instance checks compose](https://jolt-lang.net/docs/host-interop.html#instance_checks_compose)
- [Infix Notation > Parsing strings at runtime: from-string > The environment](https://jolt-lang.net/docs/api/infix.html#the_environment)
Observation: I click "Host Interop" expecting to navigate to the beginning of the page, but end up into sub-heading.
## `int`
- [Native Interop (FFI) > Binding a function](https://jolt-lang.net/docs/native-interop.html#binding_a_function)
- [Native Interop (FFI) > Binding a function > :blocking](https://jolt-lang.net/docs/native-interop.html#blocking)
- [Foreign Functions (jolt.ffi) > Binding functions](https://jolt-lang.net/docs/api/ffi.html#binding_functions)
- [Native Interop (FFI) > Binding a function > :& (variadic C functions)
](https://jolt-lang.net/docs/native-interop.html#amp_variadic_c_functions)
Observation: Same, I click "Native Interop (FFI)" expecting to navigate to the beginning of the page, but end up into sub-heading.
## `inter`
- RFC 0005: Structural Type Interference > Inference rules
- RFC 0005: Structural Type Interference > Soundness
- RFC 0004: Type Hints > Status and non-goals
- RFC 0005: Structural Type Interference > The type lattice > Termination: deth cap
Observation: Where did the previous results go?
## `intero`
- no results
Observation: Where did all the results go?
## `interop`
- Host Interop
- Cljc Interop
- Native Interop (FFI)
- Host Interop
Observation: These are what I expected.
# Conclusion
Typing "interop" the search gives slightly surprising results with a partial search query, often pointing to quite deep in sub-headings, while the final result is fine.
With partial results the sub-headings seem to be getting prioritized too much over top-level headings / page titles.
Worth checking also why "intero" doesn't return any results.
I didn't look at the implementation but these are some observations / guesses.
Contributor guide
No contributing guide indexed for this repository
Research direction
Reproduce the client-side search behavior with the queries "in", "int", "inter", "intero", and "interop", then locate the search implementation and its result-ranking entry point. Done means partial queries return the expected results, page titles or top-level headings are ranked ahead of subheadings, and clicking a page result opens the page at its beginning rather than a deep anchor.
Written by the indexing model from the issue text.
Assessment
- Domain
- search
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100