sveltejs / sveltejs/svelte.dev
Improve search results ranking
Nobody has claimed this yet.
- Dominant language
- Svelte
- Stars
- 330
- Forks
- 278
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 29
Description
Describe the problem
To use @tcc-sejohnson's example: if you search for adapter-static in the docs, the page you're probably looking for — this one — is the fifth result:
Describe the proposed solution
I think the easiest and most reliable solution would be to add keywords frontmatter to the relevant markdown files, so that if you match one of them (or a keyword starts with your search term) that document is treated as higher priority than all others.
We could indicate the keyword in the UI somehow but I don't think it's necessary.
Alternatives considered
No response
Importance
nice to have
Additional Information
No response
Contributor guide
No contributing guide indexed for this repository
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
No file, test, or entry point is named in the issue. Start by tracing how documentation search ranks results and how markdown frontmatter is read; done means a search such as adapter-static places the relevant documentation page above less relevant results.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, search
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100