docs: Ability to search non-text strings
Nobody has claimed this yet.
- Dominant language
- OCaml
- Stars
- 1.9k
- Forks
- 500
- Avg merge
- 15h 21m
- Merged PRs (30d)
- 277
Description
A common pitfall for new users is when they come across a syntax like @@ and they do not know what it is called or how to find it in the documentation. A natural thing would be to search @@ in the docs however this will not return anything.
We should improve the readthedocs search so that it can handle such searches. I'm not sure if or how this is possible, but we cannot be the only project with this issue.
Here is some related info: https://docs.readthedocs.io/en/stable/server-side-search/syntax.html
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
No repository file or test is named. Read the linked Read the Docs search syntax and investigate how this project's documentation search is configured. Done means searches for non-text strings such as @@ return relevant documentation results.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, search
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100