dwavesystems / dwavesystems/dwave-ocean-sdk
Better docs search
- Dominant language
- Python
- Stars
- 539
- Forks
- 192
- Avg merge
- 1d 2h
- Merged PRs (30d)
- 2
Description
With #123 merged, we should consider using [RtD's server-side search](https://docs.readthedocs.io/en/stable/server-side-search.html) powered by Elasticsearch, as an alternative to the sphinx-powered on-page search (see the [search](https://docs.readthedocs.io/en/stable/config-file/v2.html#search) option).
Contributor guide
Research direction
Read the linked Read the Docs server-side search documentation and the linked configuration search option, then review the context from merged issue #123. The issue does not name repository files, tests, or acceptance criteria; completion would require deciding whether and how to replace the Sphinx-powered on-page search with Read the Docs server-side search.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- elasticsearch
- Domain
- documentation, search
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100