readthedocs / readthedocs/ext-theme
Navigation search improvements for organizations
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 12
- Forks
- 6
- Avg merge
- 13h 25m
- Merged PRs (30d)
- 1
Description
Currently, the search shows project.name and project.slug in the results. Slug is a bad choice here. It is redundant to name, meaningless as concept for users outside API queries, and looks noisy in an organization, where the organization name is prepended to the slug.
At very least slug should be replaced by some project metadata, a single line describing active versions or something. It could also be the repository URL or project docs URL if this is in the search results already.
A couple other additions for the search might be some organization features in the search results:
- Team results
- Organization results (only useful to users with multiple orgs)
- Organization name in project results (also only for multiple orgs really)
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
Start by locating the navigation search implementation and the result rendering that currently displays project.name and project.slug. Review how project, team, and organization results are represented, then define the result metadata and organization context to show; done means the search presents useful project details without noisy slugs and supports the requested organization-related results.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- frontend, search
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100