Skip to content

Reorganize and refine the docs search documentation

Evan Read requested to merge eread/reorganize-and-refine-docs-search-documentation into main

What does this MR do and why?

Reorganize the documentation search docs so that the two kinds of search are introduced first, then parallel sections for doing local builds using one or the other kind of search.

Testing

  1. Check out this branch.
  2. Run SEARCH_BACKEND="lunr" make view. Open local site and Lunr.js search works.
  3. Run SEARCH_BACKEND="google" make view. Open local site and Google Programmable Search works, assuming GOOGLE_SEARCH_KEY is set.
  4. Run make view. Open local site and Google Programmable Search works, assuming GOOGLE_SEARCH_KEY is set.
  5. Run SEARCH_BACKEND="test" make view. Compilation aborts.

Screenshots, screen recordings, or links to review app

Merge request acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Edited by Evan Read

Merge request reports