solidjs / solidjs/solid-docs

[Bug]: Search feature misses important results

Aperta
#1,314 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

bug planned site improvement
Lingua principale
MDX
Stelle
292
Fork
361
Merge medio
7h 51m
PR unite (30g)
1

Descrizione

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)

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia dalla funzionalità di ricerca e consulta le issue correlate 987, 109, 1364 e 706 per il contesto e le discussioni precedenti. Determina quali API mancanti, blocchi di testo e codice e opzioni API rientrano nell'ambito, quindi verifica che il contenuto interessato sia ricercabile senza introdurre regressioni nei risultati esistenti.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Ambito
documentation, search
Tipo di issue
Bug
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.