til VS docsearch

gh annotations -repo swfz/til | jq [ { "repository": "swfz/til", "workflow_name": "slack notification", "workflow_event": "workflow_run", "workflow_path": ".github/workflows/slack.yml", "workflow_url": "https://github.com/swfz/til/actions/runs/3697438928", "job_name": "main", "job_conclusion": "success", "annotation_level": "warning", For more information see: https://github.blog/changelog/2022-09-22-github-actions-all-actions-will-begin-running-on-node16-instead-of-node12/. Please update the following actions to use Node.js 16: swfz/slack-workflow-status@feature/follow-workflow-run" } { "repository": "swfz/til", "workflow_name": "ci", "workflow_event": "push", "workflow_path": ".github/workflows/ci.yml", "workflow_url": "https://github.com/swfz/til/actions/runs/3697430624", "job_name": "build", "job_conclusion": "failure", "annotation_level": "failure", "message": "Process completed with exit code 1." } { "repository": "swfz/til", "workflow_name": "lint content", "workflow_event": "push", "workflow_path": ".github/workflows/lint.yml", "workflow_url": "https://github.com/swfz/til/actions/runs/3694817234", "job_name": "run textlint", "job_conclusion": "failure", "annotation_level": "failure", "message": "Process completed with exit code 1." } ]

Integration with A.I. tools: You can use A.I. tools to assist in drafting and reviewing documentation, enhance documentation search capabilities with tools like Algolia DocSearch and TypeSense DocSearch, and provide a support assistant chatbot like DocsBot AI that helps software users access information and troubleshoot problems.

Great work! How it would be different from Algolia DocSearch?

https://docsearch.algolia.com

Additionally, Algolia’s DocSearch has been integrated for improved search experience.

First, register with Algolia. Then you need to upload the document information in VuePress application to Algolia. DocSearch provides a crawler and UI to easily crawl index information and upload it. However, you need to meet certain conditions to apply for this service. Fortunately, the old version of DocSearch provided a solution to run the crawler yourself. So I ended up with the Run Your Own solution.

Can't use a free tier SaaS service like Algolia DocSearch. (e.g. private site, your use case dosen't fit the ToS, etc.)

When planning the feature I stated that More complex sites will probably (and should) use Algolia, which is an amazing service that I personally use for some sites (Thank you DocSearch!)

Docusaurus powers the documentation sites for many of the tools developers use every day, including Algolia Docsearch, Jest, React Native, and Redis.

Yes, search is definitely on the "roadmap" (if there is such a thing). A simple substring search across all protocols should be relatively easy to implement. But from your description it sounds like an integration with docsearch (or a similar service) would be more appropriate.

Algolia Docsearch