nushell / nushell/nushell.github.io
Doc search should not show deprecated results
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 258
- Forks
- 561
- Avg merge
- 3h 20m
- Merged PRs (30d)
- 15
Description
Describe the bug
The search feature in the book/docs returns misleading results about deprecated versions. If I search 'startup', the first result is Startup commands (jonathandturner), which is very outdated. The URL does indicate that this is old, but that's not part of the search result, and you have to scroll to the top of the page to see the version number (and you'd already have to be a user to know that this is not the newest version).
Thank you.
How to reproduce
Navigate to https://www.nushell.sh/ and search for startup
Expected behavior
I guess the expectation is that the search function would only draw from docs that are current relative to the latest version.
Screenshots
No response
Configuration
No response
Additional context
No response
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
Reproduce the startup search at https://www.nushell.sh/ and inspect how results include deprecated book/docs pages. Trace the site's search entry point and version metadata; done means current-version documentation is returned without misleading deprecated results.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, search
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100