Add search
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- javascript
- Domain
- documentation, search, web-dev
Research direction
Start by reviewing the docsite redesign and the generated _site output, then evaluate how elasticlunr could index the
, <title>, and <h*> content. Define the search-result presentation and keyboard behavior from the examples mentioned, including how API functions should be weighted. Done means the docsite has a usable custom search without the removed DuckDuckGo bar.Written by the indexing model from the issue text.
Description
In the docsite redesign we removed the duckduckgo search bar. The plan is to replace it with a custom search bar.
Current ideas for this are roughly
- use something like elasticlunr
- produce an index by scanning the generated _site, focussing the search on the
<main>,<title>, and<h*>tags with more weight on<h*>and<title> - it would be nice to recognise API functions and give them more weight so that it is possible to go to them quickly. Not sure how much work that would be.
- write js to present search results in a reasonably nice form (examples would be mdbook or the search on the tailwindcss.com site)
- make sure search can be operated by keyboard without mouse
- Dominant language
- HTML
- Stars
- 19
- Forks
- 67
- Avg merge
- 18h 40m
- Merged PRs (30d)
- 3
Contributor guide
No contributing guide indexed for this repository
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 seL4/docs
-
Difficulty 1/5 Under an hour Newbie friendliness 55/100
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
-
CI
Difficulty 3/5 1-2 days Newbie friendliness 45/100
-
CI
Difficulty 3/5 1-2 days Newbie friendliness 48/100
-
Difficulty 4/5 3-5 days Newbie friendliness 42/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
bancolombia/sentinel#22 ·
-
test md OpenCI
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
optimization optimization:agents-md-curator
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
githubnext/gh-aw-cao#13143 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 94/100
objectionary/hone-maven-plugin#1061 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
redhat-developer/rhdh-plugins#4887 · 2 comments ·