cowprotocol / cowprotocol/docs
chore: Autogenerated pages should have a low priority in search results
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5
- Forks
- 32
- PR merge metrics
- No merged PRs in 30d
Description
Background
When I do a search in docs.cow.fi, often the first results are from less helpful autogenerated pages instead of more tailored pages.
For example, when I search "appdata" the first result is this, the other four are even worse, and then the user would have to sift through all 430 results for the helpful one.
Details
By @mfw78: this can likely be done within agolia (the search agent that's used).
Acceptance criteria
- This page (or something of similar quality) surfaces first when searching for "appdata" .
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by inspecting the search configuration used by docs.cow.fi and reproduce the "appdata" query. Compare the linked autogenerated modules page with the more helpful result, then adjust ranking so the helpful page surfaces first and verify the acceptance criterion with the search results.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, search
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100