[Bug]: Search feature misses important results
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 25/100
- Issue type
- Bug
- Clarity
- Needs clarification
- Activity status
- Stale
- Domain
- documentation, search
Research direction
Start with the search feature and review related issues 987, 109, 1364, and 706 for context and prior discussion. Determine which missing APIs, text and code blocks, and API options are in scope, then verify that the affected content is searchable without regressing existing results.
Written by the indexing model from the issue text.
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)
- Dominant language
- MDX
- Stars
- 292
- Forks
- 361
- Avg merge
- 7h 51m
- Merged PRs (30d)
- 1
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from solidjs/solid-docs
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
solidjs/solid-docs#1635 ·
-
good first issue solid solidstart
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
solidjs/solid-docs#1522 ·
-
pending review
solidjs/solid-docs#1637 · 1 assignee ·
-
help wanted
solidjs/solid-docs#1636 · 4 comments ·
-
Difficulty 3/5 1-2 days Newbie friendliness 52/100
solidjs/solid-docs#1630 · 1 comment ·
All issues in solidjs/solid-docs
Similar issues
-
Add: hunch Open
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
AbdelStark/awesome-typesafe#104 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
A11y ♿️
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Link Checker Report Openautomated issue report
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
-
documentation improve or update documentation priority/low triage
Difficulty 2/5 Half a day Newbie friendliness 86/100
warpdotdev/docs#782 · 1 comment ·