[Bug]: Search feature misses important results
Personne n'a encore pris cette issue.
- Langage dominant
- MDX
- Étoiles
- 292
- Forks
- 361
- Merge moyen
- 7 h 51 min
- PR mergées (30 j)
- 1
Description
The search feature has poor performance. Some important APIs (for example, clientOnly and ParentProps) that should appear in the search results are missing.
Also, there have been requests for the ability to search within normal text and code blocks. This functionality would be helpful for users looking to find examples of specific API usage.
Certain API options, such as deferStream, are also not searchable. This can be addressed by using headings to document API options instead of tables. This is being implemented gradually.
Related issues: (for more context and discussions)
- https://github.com/solidjs/solid-docs/issues/987
- https://github.com/solidjs/solid-docs/issues/109
- https://github.com/solidjs/solid-docs/issues/1364
- https://github.com/solidjs/solid-docs/issues/706 (not directly related to this bug, but about the search engine in general)
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par la fonctionnalité de recherche et consultez les issues associées 987, 109, 1364 et 706 pour obtenir du contexte et prendre connaissance des discussions précédentes. Déterminez quelles APIs, quels blocs de texte et de code, ainsi que quelles options d'API manquants sont concernés, puis vérifiez que le contenu affecté peut être recherché sans régression des résultats existants.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Domaine
- documentation, search
- Type d'issue
- Bug
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- À l'abandon
- Clarté
- À clarifier
- Accessibilité débutants
- 25/100