search

htmlhint / HTMLHint

⚙️ The static code analysis tool you need for your HTML
https://htmlhint.com
MIT License
3.08k stars 380 forks source link

feat(docs): Implement EnhanceDocs Search #1306

Closed Alw3ys closed 1 year ago

Alw3ys commented 1 year ago

Hi there!

Hi team!

Here's a PR that needs a few variables to be replace implementing EnhanceDocs Search.

  1. Create account on https://app.enhancedocs.com/sign-up
  2. Get secret at https://app.enhancedocs.com/settings/api-keys and create github action secret with variable name ENHANCEDOCS_API_KEY with secret from https://github.com/htmlhint/HTMLHint/settings/secrets/actions/new
  3. Replace and from the dashboard (This I can do for you after you create your account) :)

Leaving here a screenshoot on how our EnhanceDocs looks like in your docs, and our licence is free for open source btw :) Screenshot 2023-04-12 at 22 56 38

coliff commented 1 year ago

Thanks for the PR! This search system looks neat but I think it might be better to use something local and not rely on a 3rd-party. Maybe https://github.com/praveenn77/docusaurus-lunr-search ?

Alw3ys commented 1 year ago

Hi @coliff! Of course there are benefits and cons to local vs self hosted and 3rd party hosted. What you propose is a local search which isn't as rich as most elastic search engines. You have many to self host yourself and when it comes to ElasticSearch many open source libraries decide to go Algolia with which in fact is 3rd party.

EnhanceDocs approach is simular to Algolia and free for open source but you leverage it's AI Models and dashboard to gain insights to what your users are asking. Screenshot 2023-04-14 at 13 48 43

So yes, you might go for local search but then you might be missing insights into what your users are searching for and what needs to be better documented so they can get their questions answered and easy out usage of your library.

Ofc, everybody has their preferences, if you still think local search fits better your needs, that's your call! Worst case of relying on a 3rd party is that maybe goes bankrup at some point and then you just have to remove it ¯_(ツ)_/¯

Alw3ys commented 1 year ago

Hey @coliff now enhancedocs is open source and can be self hosted, if you like that better!https://github.com/enhancedocs/enhancedocs

stale[bot] commented 1 year ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.