NativeScript / NativeScript/docs

Improve search results

Ouverte
#132 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
JavaScript
Étoiles
17
Forks
31
Merge moyen
8 h 51 min
PR mergées (30 j)
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

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Reproduisez la recherche stackLayout présentée dans l’issue et examinez le point d’entrée de la recherche ainsi que les métadonnées de la section de documentation. Confirmez comment les entrées de composants et d’API sont ordonnées et étiquetées. La tâche est terminée lorsque les résultats des composants précèdent les résultats associés, que les entrées de composants sont étiquetées UI Components et que les entrées d’API sont étiquetées API Reference.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
javascript
Domaine
documentation, search
Type d'issue
Fonctionnalité
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
38/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.