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 DocSearch feature to Yorkie documentation #121

Open
devleejb opened this issue Apr 6, 2024 · 0 comments
Open

Add DocSearch feature to Yorkie documentation #121

devleejb opened this issue Apr 6, 2024 · 0 comments
Labels
documentation 📔 Improvements or additions to documentation enhancement 🌟 New feature or request

Comments

@devleejb
Copy link
Member

devleejb commented Apr 6, 2024

Description:

Currently, the Yorkie documentation lacks a search feature, which hinders user navigation and information retrieval. One possible solution is to integrate DocSearch, a tool that provides search functionality for documentation websites.

DocSearch operates by crawling web pages at regular intervals and creating a searchable index based on the content it finds. It is currently available for free and can significantly improve the user experience of the Yorkie documentation by enabling users to search for specific topics or keywords.

Why:
Adding the DocSearch feature to the Yorkie documentation will enhance usability and make it easier for users to find relevant information quickly. By implementing this feature, we can improve the overall accessibility and navigability of the documentation.

Additional Information:
For more details on how DocSearch works and how to apply for the service, please refer to DocSearch official page.

@devleejb devleejb added documentation 📔 Improvements or additions to documentation enhancement 🌟 New feature or request labels Apr 6, 2024
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 enhancement 🌟 New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant