Context
There are now three separate searches — contributors, glossary, and soon the FAQ — and none of them searches the prose on the Git basics or PR checklist pages. Somebody looking for "merge conflict" has to guess which page and which box.
What to change
Files: A new build script, a new data file, a new script, all seven pages
Requirements:
- Generate a search index at build time from the page content, not at runtime
- A GitHub Action rebuilds it when content changes, in the style of
build-contributors.yml
- One search entry point that returns results across pages, with the page name shown
- Keep the index small enough to load on a phone on campus wifi — state the size in the pull request
- No search library unless you can justify the weight; the site has no build step and that is a feature
- Must degrade sensibly with JavaScript off
Acceptance criteria
How to verify locally
python3 -m http.server 8000
Then open http://localhost:8000.
Difficulty
Advanced. Design the approach and say why before writing much code — comment on the issue first and a maintainer will talk it through with you.
New here? Comment /claim on this issue and a bot will assign it to you. Then read CONTRIBUTING.md.
Stuck at any point? Comment here saying what you have tried and where it stopped working — that is not an admission of failure, it is how we find out the instructions were unclear. You can also come to a PR Debug Clinic (Oct 12 or Oct 21).
Context
There are now three separate searches — contributors, glossary, and soon the FAQ — and none of them searches the prose on the Git basics or PR checklist pages. Somebody looking for "merge conflict" has to guess which page and which box.
What to change
Files: A new build script, a new data file, a new script, all seven pages
Requirements:
build-contributors.ymlAcceptance criteria
How to verify locally
Then open http://localhost:8000.
Difficulty
Advanced. Design the approach and say why before writing much code — comment on the issue first and a maintainer will talk it through with you.
New here? Comment
/claimon this issue and a bot will assign it to you. Then read CONTRIBUTING.md.Stuck at any point? Comment here saying what you have tried and where it stopped working — that is not an admission of failure, it is how we find out the instructions were unclear. You can also come to a PR Debug Clinic (Oct 12 or Oct 21).