Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feature(discovery): add Trieve search and AI chat to the docs (old Mintlify functionality) #206

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

skeptrunedev
Copy link

@skeptrunedev skeptrunedev commented Mar 6, 2025

We are huge Coolify fans and have been sponsors since June last year. Coolify is an awesome service for our business ❤️ . Trieve provides search and AI chat for all of the Mintlify documentation sites!

Previously, when Coolify's docs were on Mintlify, it had AI chat and search that were heavily used and we wanted to restore the functionality for free to aid the general community!

We deployed a preview of the site at cooldocs.trieve.ai/docs to hopefully make this easier to review.

The functionality works as follows:

  1. We load the documentation site into a search index via the trieve-vitepress-adapter CLI package. This is included as a CI action so updates will happen automatically and the search index never falls out of date.
  2. We replace the current onClick action of the search input button with a new one that opens the Trieve search box using a client side JS script that loads async. This is minimally invasive and much easier to revert than an installed package that changes which search component gets built into the application wholesale.

Post-merge some secrets will need to be set for CI actions on the repository:

image

We can send these via a DM on discord or any other platform, cheers!

@skeptrunedev skeptrunedev changed the title feature(discovery): add Trieve search and AI chat to the docs (old Mi… feature(discovery): add Trieve search and AI chat to the docs (old Mintlify functionality) Mar 6, 2025
Copy link

gitguardian bot commented Mar 6, 2025

⚠️ GitGuardian has uncovered 1 secret following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

Since your pull request originates from a forked repository, GitGuardian is not able to associate the secrets uncovered with secret incidents on your GitGuardian dashboard.
Skipping this check run and merging your pull request will create secret incidents on your GitGuardian dashboard.

🔎 Detected hardcoded secret in your pull request
GitGuardian id GitGuardian status Secret Commit Filename
- - Generic High Entropy Secret 21a0a16 docs/public/trieve-user-script.js View secret
🛠 Guidelines to remediate hardcoded secrets
  1. Understand the implications of revoking this secret by investigating where it is used in your code.
  2. Replace and store your secret safely. Learn here the best practices.
  3. Revoke and rotate this secret.
  4. If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider


🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

@skeptrunedev
Copy link
Author

⚠️ GitGuardian has uncovered 1 secret following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

Since your pull request originates from a forked repository, GitGuardian is not able to associate the secrets uncovered with secret incidents on your GitGuardian dashboard. Skipping this check run and merging your pull request will create secret incidents on your GitGuardian dashboard.

🔎 Detected hardcoded secret in your pull request
🛠 Guidelines to remediate hardcoded secrets
🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

This is intentional as it is a specifically permission'ed key meant for public accessibility.

@skeptrunedev skeptrunedev marked this pull request as ready for review March 6, 2025 23:33
@ShadowArcanist ShadowArcanist added the ⚠️ High Priority Critical documentation tasks requiring immediate attention. label Mar 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
⚠️ High Priority Critical documentation tasks requiring immediate attention.
Projects
Status: Community
Development

Successfully merging this pull request may close these issues.

3 participants