arrow-kt / arrow-website

This is the main website for Arrow, the functional companion to Kotlin's Standard Library
https://arrow-kt.io
Apache License 2.0
10 stars 22 forks source link

feat: implement EnhanceDocs Search #184

Closed Alw3ys closed 1 year ago

Alw3ys commented 1 year ago

As demand from @raulraja to implement EnhanceDocs on Arrow Documentation.

What does this PR includes?

TODO @raulraja: 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/arrow-kt/arrow-website/settings/secrets/actions/new

Preview: Screenshot 2023-05-01 at 13 23 32

raulraja commented 1 year ago

@franciscodr Could you help with the setup?

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/arrow-kt/arrow-website/settings/secrets/actions/new

@Alw3ys also mentioned that there is a Slack bot that we can connect to the AI assistant to use it from slack as well

Alw3ys commented 1 year ago

Hey @raulraja , any blockers?

nomisRev commented 1 year ago

@Alw3ys, I ran into a white page after trying to get a secret from https://app.enhancedocs.com/settings/api-keys. This is currently blocking me to add the secret to the repo. This happened after trying to login in through the Github login.

Alw3ys commented 1 year ago

Um, interesting, I think you must sign up. I don't see that you have created an account. but I will look into this so messaging is more clear

https://app.enhancedocs.com/sign-up

alternatively while this is being solved I’ve shared the credentials with you on a secret gist on twitter DM which I will delete after you get it

franciscodr commented 1 year ago

Hi @Alw3ys, sorry for the late response. Thanks for bringing this proposal to our website. It looks great!

I would like to ask if there's another way to integrate EnhancedDocs into our website rather than replacing the current search engine. We're considering having a complementary feature like a chat prompt where the user can interact with EnhancedDocs while maintaining the current search component in the top bar.

Alw3ys commented 1 year ago

For sure there is! you can test it here, check the chat button on the bottom corner to the right.

https://docs.enhancedocs.com/

If you like that better, I'll be happy to update the PR

Alw3ys commented 1 year ago

Updated the PR: here's a screenshot: Screenshot 2023-05-10 at 19 22 46

Alw3ys commented 1 year ago

Awesome, just make sure to add the API key to the github action secrets as I mention on my first commit before merge, otherwise the build will fail with a 403, otherwise ready to merge :)

franciscodr commented 1 year ago

I already added the API key in the repo's secrets. The AI assistant looks great, @Alw3ys!

Alw3ys commented 1 year ago

Sure you need to find a way to download it and upload with the CLI, but if you wait a week or so we will release our new version of managed build and this can be done. will keep you posted!