Skip to content
This repository has been archived by the owner on Sep 22, 2023. It is now read-only.

Implement Algolia DocSearch #957

Merged
merged 9 commits into from
Sep 5, 2023
Merged

Implement Algolia DocSearch #957

merged 9 commits into from
Sep 5, 2023

Conversation

markzegarelli
Copy link
Contributor

  • scaffold
  • search box installed
  • search box installed
  • search working
  • search prototype
  • Update section font size

Amplitude Developer Docs PR

Description

This update replaces MkDocs standard Lunr.js search with Algolia DocSearch.

DocSearch provides the following benefits over Lunr:

  • Search analytics, so that we can see what users are searching for, and how those searches perform
  • Index customization, so that we can prioritize or deprioritze sections of the site more easily. For example, we should priortize
    current SDKs over maintenance versions.

Deadline

When do these changes need to be live on the site?

Change type

  • Doc bug fix. Fixes #[insert issue number]. Amplitude contributors include Jira issue number.
  • Doc update.
  • New documentation.
  • Non-documentation related fix or update.

PR checklist:

  • My documentation follows the style guidelines of this project.
  • I previewed my documentation on a local server using mkdocs serve.
  • Running mkdocs serve didn't generate any failures.
  • I have performed a self-review of my own documentation.

@amplitude-dev-docs

@github-actions
Copy link

github-actions bot commented Sep 1, 2023

🦙 MegaLinter status: ✅ SUCCESS

Descriptor Linter Files Fixed Errors Elapsed time

See detailed report in MegaLinter reports
Set VALIDATE_ALL_CODEBASE: true in mega-linter.yml to validate all sources, not only the diff

MegaLinter is graciously provided by OX Security

@aws-amplify-us-east-1
Copy link

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-957.d19s7xzcva2mw3.amplifyapp.com

@markzegarelli markzegarelli merged commit 3ba965d into main Sep 5, 2023
@markzegarelli markzegarelli deleted the algolia-docsearch branch September 5, 2023 22:48
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant