theupdateframework / theupdateframework/theupdateframework.io
[docsy] Enable site search
Open
Nobody has claimed this yet.
docsy
enhancement
- Dominant language
- HTML
- Stars
- 25
- Forks
- 46
- PR merge metrics
- No merged PRs in 30d
Description
Google Custom Search Engine (GCSE) approach:
- Setup GSC: https://search.google.com/search-console?resource_id=sc-domain%3Atheupdateframework.io
- Enable GCSE. For details, see Configure search with a Google Custom Search Engine
- Enable search over entire website
- Note GCSE ID:
06ecafa260afd40f9
- Configure Hugo + Docsy to use new GCSE - #92
- Ensure that the GCSE ID is recognized as a non-profit. (WIP)
In case we can't get GCSE to work with the site's CSP, we should consider alternatives.
- Support offline search. For options, see https://www.docsy.dev/docs/adding-content/search/
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.
Research direction
Start with issue #92 and Docsy's search configuration guide, using the recorded GCSE ID 06ecafa260afd40f9. Check whether the site's CSP permits GCSE, then verify that site-wide search works; if it does not, evaluate the documented offline-search alternatives.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- hugo
- Domain
- search, web-dev
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100