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

Documentation Search - DocSearch Application #341

Open
smilo7 opened this issue Aug 12, 2021 · 2 comments
Open

Documentation Search - DocSearch Application #341

smilo7 opened this issue Aug 12, 2021 · 2 comments
Projects

Comments

@smilo7
Copy link
Collaborator

smilo7 commented Aug 12, 2021

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.
  • ✔️
  1. Your website must be publicly available. We do not host search indices for websites that are available behind an authentication or a private network.
  • ✔️
  1. Your website must be a documentation website. We do not index blogs or commercial content.
  • ✔️
  1. 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 smilo7 added this to Medium Priority for Release in Sema Dev Jan 4, 2022
@smilo7
Copy link
Collaborator Author

smilo7 commented Jan 17, 2022

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
Copy link
Collaborator Author

smilo7 commented Jan 25, 2022

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Sema Dev
Medium Priority for Release
Development

No branches or pull requests

1 participant