Add code and documentation search to the global search results
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Markdown
- Stars
- 192
- Forks
- 389
- Avg merge
- 23h 8m
- Merged PRs (30d)
- 20
Description
https://sherlocode.com/ and https://doc.sherlocode.com/ have proven to be extremely helpful.
We've received a lot of feedback asking for an integration in ocaml.org. We should explore how we can improve the search engine to return code and documentation results.
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
Review the current global search on ocaml.org alongside the Sherlocode and Sherlocode documentation sites linked in the issue. Define how code and documentation results should be integrated and what search behavior would count as complete; the issue names no files, tests, or implementation entry point.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ocaml
- Domain
- documentation, search
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100