[Bug]: Search feature misses important results
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 292
- Forks
- 361
- Avg merge
- 7h 51m
- Merged PRs (30d)
- 1
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)
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.
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.
Assessment
- Domain
- documentation, search
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100