NativeScript / NativeScript/docs

Improve search results

Open
#132 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
17
Forks
31
Avg merge
8h 51m
Merged PRs (30d)
2

Description

I think there are 2 things to improve in the results, one is the order and the other is the name of the section in which they appear.
For example, in the image I show I am searching for stackLayout and searches related to stackLayout appear before the component itself.

  1. Improvement in order: When performing the search I think the entry to the component should appear first
  2. Incoherent titles: When searching for stackLayout the entry that is related to the component appears in the Documentation section. It's all documentation, right? I think a more coherent title would be the documentation space itself: UI Components.
  3. Incorrect section: This is related to the previous point, 2 StackLayout entries appear within Documentation, one is the component and the other is the API. This is quite confusing, I think each entry should appear with the title of the documentation section, for the component UI Components and for the API API Reference.
image

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the stackLayout search shown in the issue and inspect the search entry point and documentation-section metadata. Confirm how component and API entries are ordered and labeled. Done means component results precede related results, with component entries labeled UI Components and API entries labeled API Reference.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation, search
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.