search

mimic-sussex / sema

Sema – A Playground for Live Coding Music and Machine Learning
https://sema.codes
MIT License
151 stars 51 forks source link

Documentation Search - DocSearch Application #341

Open smilo7 opened 3 years ago

smilo7 commented 3 years ago

I have implemented a search box for the documentation in PR - #340

Currently it uses the default api key provided to test it out by docsearch (see https://docsearch.algolia.com/docs/dropdown)

In order to have search results from the sema documentation we need to complete an application for the DocSearch service.

How to apply: https://docsearch.algolia.com/docs/who-can-apply

the checklist from the link above is as follows.

  1. You must be the owner of the website, or at least have the permissions to update its content. You'll have to include a JavaScript snippet to enable DocSearch.

    • ✔️

  2. Your website must be publicly available. We do not host search indices for websites that are available behind an authentication or a private network.

    • ✔️

  3. Your website must be a documentation website. We do not index blogs or commercial content.

    • ✔️

  4. Your website must have some final content. We won't index empty websites nor those filled with lorem ipsum placeholder content. Please, wait until you have written some documentation before applying. We would be happy to help you as soon as you have a steady design.

To apply: https://docsearch.algolia.com/docs/apply/ probably do this with the sema gmail acount?

smilo7 commented 2 years ago

All doc pages now have some content on even if it just placeholder. Once we move the new version to main site I will start the application process.

smilo7 commented 2 years ago

I have sent of an application since we are now on sema.codes.