dart-lang / dart-lang/pub-dev

Provide previews of Readmes on search result pages

Open
#4,367 5 comments 0 reactions 0 assignees View on GitHub
Area: search Type: enhancement
Dominant language
Dart
Stars
944
Forks
184
Avg merge
1d 15h
Merged PRs (30d)
12

Description

In a recent user study, we observed that users open the package page and close the tab immediately, when there is no clear Readme. If we provide a preview of Readme on the search result page, we can help users avoid visiting packages with low-quality Readme and save time for the searchers. Literature also suggests to use thumbnail representations of documents for rapid assessment of document relevance prior to selection. (Google Search removed it due to low usage, but our users may benefit by just seeing what headings or images a Readme page has.)

Contributor guide

Open the contributing guide

Research direction

Start by locating the search-result page entry point and reviewing how package README information is currently represented. Clarify the preview's scope with maintainers, including whether it should show headings, images, or other thumbnail content; done means users can assess README quality without opening the package page.

Written by the indexing model from the issue text.

Assessment

Tech stack
dart
Domain
search, web-dev
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.