Skip to content

docs: add search to website using Algolia #1302

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jul 24, 2025
Merged

docs: add search to website using Algolia #1302

merged 1 commit into from
Jul 24, 2025

Conversation

chewong
Copy link
Collaborator

@chewong chewong commented Jul 23, 2025 •
edited
Loading

Reason for Change:

Adding search functionality to our website by following https://docusaurus.io/docs/search#using-algolia-docsearch

image image

Added the new secrets as repository secrets

image

Requirements

  • added unit tests and e2e tests (if applicable).

Issue Fixed:

Fixes #1197
Fixes #1206

Notes for Reviewers:

@chewong
docs: add search to website using Algolia
4346548 
Signed-off-by: Ernest Wong <chwong719@gmail.com>
@chewong chewong requested a review from sozercan July 23, 2025 22:41
@chewong chewong requested review from Fei-Guo and zhuangqh as code owners July 23, 2025 22:41
@kaito-pr-agent Kaito PR Agent
Copy link

Title

Add Algolia search to website

Description

  • Added Algolia search functionality to the website

  • Configured environment variables for Algolia in CI/CD pipeline

Changes walkthrough 📝

Relevant files
Enhancement
docusaurus.config.js
Add Algolia search configuration                                                 

website/docusaurus.config.js

  • Added Algolia configuration to docusaurus.config.js
  • Included environment variables for Algolia app ID and API key
    		• +6/-0     
    deploy-docs.yml
    Set Algolia environment variables in CI/CD                             

    .github/workflows/deploy-docs.yml

  • Added environment variables for Algolia app ID and API key in
    deploy-docs.yml
    		• +3/-0     
    Need help?
  • Type /help how to ... in the comments thread for any questions about PR-Agent usage.
  • Check out the documentation for more information.
    		•

    @kaito-pr-agent Kaito PR Agent
    Copy link

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪
    🧪 No relevant tests
    🔒 Security concerns

    Sensitive information exposure:
    The use of environment variables for ALGOLIA_APP_ID and ALGOLIA_API_KEY is correct, but ensure these secrets are not logged or exposed in any way during the build or deployment process.

    ⚡ Recommended focus areas for review

    Default Values

    The default values for ALGOLIA_APP_ID and ALGOLIA_API_KEY are set to "DUMMY_APP_ID" and "DUMMY_API_KEY". These should be removed or replaced with actual values before deployment to avoid potential issues.

     
    appId: process.env.ALGOLIA_APP_ID || "DUMMY_APP_ID",
apiKey: process.env.ALGOLIA_API_KEY || "DUMMY_API_KEY",
    Secret Usage

    Ensure that the secrets ALGOLIA_APP_ID and ALGOLIA_API_KEY are correctly set in the repository settings and are not exposed in any logs or outputs.

     
    ALGOLIA_APP_ID: ${{ secrets.ALGOLIA_APP_ID }}
ALGOLIA_API_KEY: ${{ secrets.ALGOLIA_API_KEY }}

    @kaito-pr-agent Kaito PR Agent
    Copy link

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Impact
    Security
    Remove dummy API keys

    Remove hardcoded dummy values for appId and apiKey to prevent accidental exposure.

    website/docusaurus.config.js [128-133]

     algolia: {
-    appId: process.env.ALGOLIA_APP_ID || "DUMMY_APP_ID",
-    apiKey: process.env.ALGOLIA_API_KEY || "DUMMY_API_KEY",
+    appId: process.env.ALGOLIA_APP_ID,
+    apiKey: process.env.ALGOLIA_API_KEY,
     indexName: 'KAITO',
     contextualSearch: true,
 }
    Suggestion importance[1-10]: 8

    __

    Why: Removing hardcoded dummy values enhances security by preventing accidental exposure of sensitive information.

    		Medium
    Possible issue
    Verify GitHub Secrets

    Ensure that ALGOLIA_APP_ID and ALGOLIA_API_KEY are correctly set in GitHub Secrets
    to avoid deployment issues.

    .github/workflows/deploy-docs.yml [60-62]

    +env:
+  ALGOLIA_APP_ID: ${{ secrets.ALGOLIA_APP_ID }}
+  ALGOLIA_API_KEY: ${{ secrets.ALGOLIA_API_KEY }}
 
-
    Suggestion importance[1-10]: 6

    __

    Why: Ensuring that ALGOLIA_APP_ID and ALGOLIA_API_KEY are correctly set in GitHub Secrets helps avoid deployment issues, but this is more of a verification step rather than a code change.

    		Low

    zhuangqh
    zhuangqh reviewed Jul 23, 2025
    View reviewed changes
    @chewong chewong merged commit 03d8665 into kaito-project:main Jul 24, 2025
    16 of 18 checks passed
    @chewong chewong deleted the fix-1197 branch July 24, 2025 01:45
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @zhuangqh zhuangqh zhuangqh approved these changes

    @sozercan sozercan Awaiting requested review from sozercan

    @Fei-Guo Fei-Guo Awaiting requested review from Fei-Guo Fei-Guo is a code owner

    Assignees
    No one assigned
    Labels
    Review effort 3/5
    Projects
    KAITO Roadmap
    Status: Done
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.

    Improve KAITO onboarding experience docs: add search to website
    2 participants
    @chewong @zhuangqh