Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Algolia DocSearch to navbar #39

Open
aridyckovsky opened this issue Apr 17, 2021 · 3 comments
Open

Add Algolia DocSearch to navbar #39

aridyckovsky opened this issue Apr 17, 2021 · 3 comments
Assignees
Labels
enhancement New feature or request feature This is not a bug or issue with Start Your Lab. It is a feature request for the future.

Comments

@aridyckovsky
Copy link
Member

Is your feature request related to a problem? Please describe.
As the website expands in content, a searchable interface will be very helpful.

Describe the solution you'd like
We're will try to use https://docsearch.algolia.com/ because it integrates seamlessly with Docusaurus sites. See https://docusaurus.io/docs/api/themes/@docusaurus/theme-search-algolia for more details.

@aridyckovsky aridyckovsky added enhancement New feature or request feature This is not a bug or issue with Start Your Lab. It is a feature request for the future. labels Apr 17, 2021
@aridyckovsky aridyckovsky self-assigned this Apr 17, 2021
@aridyckovsky
Copy link
Member Author

Note: I've already applied for an index and API key via https://docsearch.algolia.com/apply/, as required for https://docusaurus.io/docs/2.0.0-alpha.72/search#connecting-algolia

@aridyckovsky
Copy link
Member Author

aridyckovsky commented Apr 19, 2021

Received a reply stating that our site does not fit within the criteria to be indexed with DocSearch. The reason stated was that the site was evaluated as not documentation. It seems to me that the issue may be the early-stage nature of the documentation. I've followed up to inquire further, and it may just be a "wait and try again later" situation.

@aridyckovsky
Copy link
Member Author

Update on the previous comment: DocSearch is a suitable option and we can use it, but we will need to have a more developed site before indexing can take place

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request feature This is not a bug or issue with Start Your Lab. It is a feature request for the future.
Projects
None yet
Development

No branches or pull requests

1 participant