[Bug]: Search feature misses important results
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- MDX
- Estrellas
- 292
- Forks
- 361
- Merge medio
- 7 h 51 min
- PR fusionados (30 d)
- 1
Descripción
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)
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza con la función de búsqueda y revisa los issues relacionados 987, 109, 1364 y 706 para obtener contexto y consultar discusiones anteriores. Determina qué APIs, bloques de texto y código, y opciones de API faltantes están dentro del alcance, y luego verifica que el contenido afectado se pueda buscar sin empeorar los resultados existentes.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Área
- documentation, search
- Tipo de issue
- Error
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 25/100