search

WalletWasabi / WasabiDoc

This is the Wasabi documentation, an archive of knowledge about the open-source, non-custodial and privacy-focused Bitcoin wallet for desktop.
https://docs.wasabiwallet.io
MIT License
103 stars 84 forks source link

Search in content #1612

Closed turbolay closed 6 months ago

turbolay commented 1 year ago

Currently, the search bar only searches in the titles, it would be much better to search in the content as well. I talked to @CAnorbo about it a few months ago and if I remember correctly there should be an option just to change this behavior.

CAnorbo commented 1 year ago

For this, there is a 3rd party search engine called Algolia that we could use with VuePress. First, we have to send our website for indexing and they'll give us an API key.

Read more here: https://v2.vuepress.vuejs.org/reference/plugin/docsearch.html

turbolay commented 1 year ago

Can we proceed with this? I think it would be a really nice improvement. I've seen it's free and it seems easy to implement

MaxHillebrand commented 1 year ago

We're already using algolia, afaik it searches content too.

turbolay commented 1 year ago

We're already using algolia, afaik it searches content too.

We are only searching in the titles right now. In our doc, ctrl c + ctrl v a line from the doc and you won't have result In this doc https://v2.vuepress.vuejs.org/reference/plugin/docsearch.html#indexname, ctrl c + ctrl v a line will find the relevant article. It's much better. I'm having a really hard time navigating the doc because of this.

yahiheb commented 12 months ago

Fixed by #1613.

yahiheb commented 11 months ago

Reopening this since #1613 was reverted temporarily by #1617

yahiheb commented 10 months ago

Again reopening this since #1622 was reverted by #1625

molnard commented 10 months ago

👁️

MarnixCroes commented 9 months ago

cACK

@CAnorbo any plan for this? -> steps what to do next?

CAnorbo commented 9 months ago

We have two options, the old search or the new. Choose one and go with it. It's a really basic framework, if we'd like to keep it, there are no other options.

MarnixCroes commented 9 months ago

ok. the new search would be great, if it works correctly. It was removed because some basic searches were missing/not working.

CAnorbo commented 9 months ago

Instead of removing it, you should play on the Admin area of that index. I gave access to Yahia when this issue appeared. It's an admin interface, no programing is needed so anyone can play it.

turbolay commented 9 months ago

I checked this admin area as well before removing and there are hundreds of entries, are all these custom? Who entered all this?

CAnorbo commented 9 months ago

It's a scheduled crawler., that runs I guess daily.

molnard commented 9 months ago

@yahiheb What is the status of this?

yahiheb commented 9 months ago

There is nothing new about it, @CAnorbo tried to fix this using Algolia but couldn't get it to work properly so we reverted the changes.

molnard commented 9 months ago

Maybe there was a misunderstanding. What is the next step @yahiheb ? wontfix?

yahiheb commented 9 months ago

No it is not wontfix, I think we should simply leave this issue open, and maybe get back to it once we figure out how to properly configure Algolia, or once we have a another solution.

molnard commented 9 months ago

once we have a another solution

Is there another solution?

yahiheb commented 9 months ago

Is there another solution?

I don't know.

molnard commented 9 months ago

I don't know.

Can you look around or make someone look around?

yahiheb commented 9 months ago

I guess using Algolia is good, we just need to figure out how to properly configure it.

These projects use Algolia and it works well: https://docs.btcpayserver.org/ https://v2.vuepress.vuejs.org/

molnard commented 9 months ago

So it was reverted last time - before configuration?

molnard commented 9 months ago

How to proceed to avoid similar situation @yahiheb ?

molnard commented 9 months ago

What is the next step here @yahiheb ?

yahiheb commented 9 months ago

As I have mentioned above and as I have told you last week on Slack we could check how some of the projects use Algolia to search in content.

molnard commented 9 months ago

And what did you find?

yahiheb commented 9 months ago

Btcpaysernver uses Algolia in there docs, maybe these issues/PRs can help us fix this: https://github.com/btcpayserver/btcpayserver-doc/issues/628 https://github.com/btcpayserver/btcpayserver-doc/pull/530 https://github.com/btcpayserver/btcpayserver-doc/pull/630 https://github.com/btcpayserver/btcpayserver-doc/pull/794

CAnorbo commented 8 months ago

Made a new PR, pls test: https://github.com/zkSNACKs/WasabiDoc/pull/1672

molnard commented 8 months ago

What's up with this @yahiheb ?

molnard commented 8 months ago

I give up. I have no more energy for this, good luck to whoever will be my successor.

CryingSadGIF

turbolay commented 8 months ago

We are still waiting on the same thing for since some time now, which is the docs on the .co website. This feature is parked until then because there is no way to merge without breaking anything for an extensive amount of time.

turbolay commented 6 months ago

This issue was a really great display of absolute lack of skills, project management, care of the contributors for the project.

A lead that says "I tried all I could" when in fact he simply spammed "what's up with this?" without doing anything and with no context of what was going on. A maintainer of the docs that passed down the problem to someone else when he simply tried to make the first step without proper configuration nor anything A maintainer of the server that failed in 2 months to simply deploy a test version of the docs despite my repeated requests to do so.........

molnard commented 6 months ago

The one who will achieve success here can only judge me!