grammyjs / grammyjs/website

Reliably rank /ref pages below any other page

Open
#1,281 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
52
Forks
138
PR merge metrics
No merged PRs in 30d

Description

Currently, all pages are collected into the same pool. The records extracted from each page are then ranked based on a custom `pageRank` property. This works rather poorly as it interferes with other ranking criteria.

In particular, if a built-in attribute already acts as a tiebreaker, our custom ranking criteria are never evaluated. (The configuration at `site/docs/.vitepress/configs/algolia/crawler.js` looks like we modified the built-in criteria, but the dashboard clearly places the `pageRank` on position 7 after all the other built-in tiebreakers. Not sure what's going on here.)

We should either

- fix the ranking config such that the page rank is considered,
- use facets and two search queries to clearly separate the two result sets, or
- come up with another solution not mentioned above

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading site/docs/.vitepress/configs/algolia/crawler.js and inspect how the crawler assigns pageRank and configures ranking. Compare that configuration with the Algolia dashboard behavior described in the issue. Done means /ref pages reliably rank below every other page, using a validated approach and documenting or testing the resulting search behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
search
Issue type
Bug
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.