🚀 Feature: Search in documentation

[loftwah]

🔖 Feature description

I'm possibly being a bit precious here, but it would be cool to have a search feature within the documentation. It could be a small input box above the Getting Started title in the menu.

🎤 Pitch

I wanted to find something in the docs quickly, and I would have been able to easily do it with the ability to search within the docs. I can easily do this by searching with Google on the URL, but it is an easy feature to implement in most places and improves user experience, so why not?

👀 Have you spent some time to check if this issue has been raised before?

• [X] I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• [X] I have read the Code of Conduct

[stnguyen90]

@loftwah thanks for creating this issue! 🙏🏼 This is definitely something we want to add!

[gewenyu99]

This is planned 👀 I'll try pushing for this in the next round of priority items for docs.

[SoulPancake]

@gewenyu99 Would love to participate in this, Will this search be more heuristic or NLP based? I want to contribute to building this feature in both cases.

[loftwah]

You could go all out but it is only a small documentation repository so I was thinking something minimal and quick. I can be involved if anyone wants to work on it this weekend. I would start somewhere like this.

EDIT: even better, here

[SoulPancake]

@loftwah I would love to do it this weekend!

[loftwah]

I'm keen. Hit me up in the Appwrite Discord if you'd like to pair up. I'm not familiar with phtml yet so I'll read up on it beforehand. I found a solution that might be suitable but I need to make sure it is compatible first.

EDIT: I am obviously not a PHP developer primarily 😂 phtml is just:

• PHP: Page doesn't contain view-related code
• PHTML: Page contains little (if any) data logic and the most part of it is presentation-related

[loftwah]

I wrote a search function in PHP here. It works, but I'm not sure this is the best approach. We might want to use a third-party package.

[SoulPancake]

@loftwah Can we use something like this

[loftwah]

Have you tried it out? I'm going to look at this soon. I'm focussing on the day job until the Christmas holidays, and I'll have a look at it again then. If you beat me to it, that is fine too.

I had a quick look at it and I think that one relies on having Magento running somewhere. I came by something called Lyra that can be dropped in within HTML.

[SoulPancake]

I'm starting parallelly with some UI parts too and some mock code that we can plug our search logic later

However finding it difficult to run it locally, Any advise would help

[loftwah]

I saw this in the Discord server. I think they have an idea about how they want it done. I've asked them to reach out if we can get involved with anything. Less work for us :)

Steven — Today at 2:04 AM It might be best to leave the search feature to us. We may be particular about the design and functionality so I wouldn't want your time to be wasted if we don't use what you make.