NativeScript / NativeScript/docs

Improve search results

Offen
#132 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
JavaScript
Sterne
17
Forks
31
Ø Merge
8 Std. 51 Min.
Gemergte PRs (30 T.)
2

Beschreibung

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

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Reproduziere die im Issue gezeigte stackLayout-Suche und prüfe den Einstiegspunkt der Suche sowie die Metadaten des Dokumentationsabschnitts. Bestätige, wie Komponenten- und API-Einträge geordnet und beschriftet werden. Die Aufgabe ist abgeschlossen, wenn Komponentenergebnisse vor zugehörigen Ergebnissen erscheinen, Komponenteneinträge mit UI Components und API-Einträge mit API Reference beschriftet sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript
Bereich
documentation, search
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
38/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.