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

fix(docs): Delete Clojure from supported language #2795

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

Conversation

highpon
Copy link
Contributor

@highpon highpon commented Jan 7, 2025

Description

Currently, Vald is not supported Clojure client.
This PR deletes description of Clojure client from docs.

Related Issue

Versions

  • Vald Version: v1.7.15
  • Go Version: v1.23.4
  • Rust Version: v1.83.0
  • Docker Version: v27.4.0
  • Kubernetes Version: v1.32.0
  • Helm Version: v3.16.3
  • NGT Version: v2.3.5
  • Faiss Version: v1.9.0

Checklist

Special notes for your reviewer

Summary by CodeRabbit

  • Documentation
    • Removed Clojure from the list of supported client libraries
    • Removed Clojure-related configuration pattern in .prh.yaml

Copy link
Contributor

coderabbitai bot commented Jan 7, 2025

📝 Walkthrough

Walkthrough

This pull request involves removing references to Clojure from the project configuration and documentation. The changes include deleting a pattern in the .prh.yaml configuration file related to Clojure and removing Clojure from the list of supported client libraries in the docs/overview/about-vald.md file. The modifications suggest a reduction in Clojure-related support within the project.

Changes

File Change Summary
.prh.yaml Removed Clojure pattern configuration
docs/overview/about-vald.md Removed Clojure from list of supported client libraries

Possibly related PRs

Suggested labels

priority/low, size/S, actions/backport/release/v1.7

Suggested reviewers

  • vankichi
  • kpango

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6065fd9 and f09669d.

📒 Files selected for processing (2)
  • .prh.yaml (0 hunks)
  • docs/overview/about-vald.md (1 hunks)
💤 Files with no reviewable changes (1)
  • .prh.yaml
🔇 Additional comments (1)
docs/overview/about-vald.md (1)

60-60: LGTM! Documentation update is accurate.

The removal of Clojure from the supported client libraries list aligns with the PR objectives and accurately reflects the current state of support.

Let's verify there are no other Clojure references in the documentation:

✅ Verification successful

Documentation is consistent and complete

The removal of Clojure from the supported client libraries list is consistent across all documentation. No remaining Clojure references were found in the codebase.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any remaining references to Clojure in documentation
rg -i "clojure" docs/

Length of output: 21


Script:

#!/bin/bash
# Comprehensive search for Clojure references
echo "=== Searching entire codebase for Clojure ==="
rg -i "clojure" .

echo -e "\n=== Searching for client library related files ==="
fd -t f "client|sdk" -e md -e txt

echo -e "\n=== Checking README files ==="
fd README -t f -e md

Length of output: 1544


Script:

#!/bin/bash
# Check SDK documentation content
echo "=== Checking SDK documentation ==="
cat docs/user-guides/sdks.md

echo -e "\n=== Checking client API config documentation ==="
cat docs/user-guides/client-api-config.md

Length of output: 21301


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@highpon highpon changed the title fix(docs): Delete clojure from supported language fix(docs): Delete Clojure from supported language Jan 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants