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

[docs] add support for searching the docs #1431

Closed
zivkovicmilos opened this issue Dec 12, 2023 · 4 comments
Closed

[docs] add support for searching the docs #1431

zivkovicmilos opened this issue Dec 12, 2023 · 4 comments
Assignees
Labels
📖 documentation Improvements or additions to documentation

Comments

@zivkovicmilos
Copy link
Member

Description

Since we utilize Docusaurus as one of the main documentation frameworks, we should add in the option to index / search the documentation.

Important

The docs need to be deployed to docs.gno.land, before attempting any of the options below

For Docusaurus we essentially have 2 options:

  • Apply for Algolia's DocSearch program (free for open source projects); this way, Algolia indexes everything for us, and we just utilize their services in the docs
  • Host our own DocSearch instance, which crawls and indexes the docs; a bit tedious, but there is a chance we might be rejected by Algolia's program for whatever reason 🤷‍♂️

More information can be found here.

Please ping @alexiscolin if he has bandwidth once we have search support, to coordinate styling the search window 🙏

@zivkovicmilos zivkovicmilos added the 📖 documentation Improvements or additions to documentation label Dec 12, 2023
@leohhhn
Copy link
Contributor

leohhhn commented Dec 12, 2023

Related

@leohhhn
Copy link
Contributor

leohhhn commented Jan 11, 2024

Applied for free Algolia indexing. Waiting on the reply currently.

@leohhhn
Copy link
Contributor

leohhhn commented Feb 27, 2024

Since Algolia is not getting back to us, we can try to utilize @albttx's suggestion: Meilisearch. We would need to set it up on our own fully, if we do not want to pay.

@albttx would be great if you can look into this once all of the GovGen stuff is complete.

@zivkovicmilos
Copy link
Member Author

This was closed by gnolang/docs.gno.land#6 and gnolang/docs.gno.land#5

Thank you @alexiscolin and @albttx 🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 documentation Improvements or additions to documentation
Projects
Status: Done
Development

No branches or pull requests

3 participants