Add search

Abierto
#292 3 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
25/100
Tipo de issue
Nueva funcionalidad
Claridad
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
javascript

Línea de trabajo

Start by reviewing the docsite redesign and the generated _site output, then evaluate how elasticlunr could index the

, <title>, and <h*> content. Define the search-result presentation and keyboard behavior from the examples mentioned, including how API functions should be weighted. Done means the docsite has a usable custom search without the removed DuckDuckGo bar.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

enhancement

In the docsite redesign we removed the duckduckgo search bar. The plan is to replace it with a custom search bar.

Current ideas for this are roughly

  • use something like elasticlunr
  • produce an index by scanning the generated _site, focussing the search on the <main>, <title>, and <h*> tags with more weight on <h*> and <title>
  • it would be nice to recognise API functions and give them more weight so that it is possible to go to them quickly. Not sure how much work that would be.
  • write js to present search results in a reasonably nice form (examples would be mdbook or the search on the tailwindcss.com site)
  • make sure search can be operated by keyboard without mouse
Lenguaje dominante
HTML
Estrellas
19
Forks
67
Merge medio
17 h 11 min
PR fusionados (30 d)
5

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de seL4/docs

Todos los issues de seL4/docs

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.