solidjs / solidjs/solid-docs

[Bug]: Search feature misses important results

Offen
#1,314 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

bug planned site improvement
Vorherrschende Sprache
MDX
Sterne
292
Forks
361
Ø Merge
7 Std. 51 Min.
Gemergte PRs (30 T.)
1

Beschreibung

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)

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginnen Sie mit der Suchfunktion und prüfen Sie die verwandten Issues 987, 109, 1364 und 706, um Kontext und frühere Diskussionen zu erhalten. Bestimmen Sie, welche fehlenden APIs, Text- und Codeblöcke sowie API-Optionen im Umfang liegen, und überprüfen Sie anschließend, dass die betroffenen Inhalte durchsuchbar sind, ohne bestehende Ergebnisse zu beeinträchtigen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Bereich
documentation, search
Issue-Typ
Bug
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.