Skip to content

Conversation

@miguelmanlyx
Copy link

@miguelmanlyx miguelmanlyx commented Dec 15, 2025

Purpose

Add documentation for AI Badgr, an OpenAI-compatible LLM provider, in the framework integrations section. AI Badgr uses tier-based model naming (basic/normal/premium) and can work with vLLM as a backend or be accessed as a hosted service.

Test Plan

# Verify markdown linting
pre-commit run --hook-stage manual markdownlint --files docs/deployment/frameworks/aibadgr.md

# Verify documentation builds
API_AUTONAV_EXCLUDE=vllm mkdocs build

Test Result

  • Markdown linting: ✅ Passed
  • Documentation build: ✅ Generated site/deployment/frameworks/aibadgr/index.html
  • Pattern consistency: ✅ Matches existing framework docs (LobeChat, Chatbox, etc.)

Changes

New file: docs/deployment/frameworks/aibadgr.md

Documents two integration scenarios:

  1. vLLM as backend: Configure AI Badgr to use vLLM's OpenAI-compatible endpoint
  2. AI Badgr as provider: Connect to AI Badgr's hosted service using tier models

Example usage with environment variables:

import os
from openai import OpenAI

client = OpenAI(
    base_url=os.getenv("AIBADGR_BASE_URL", "https://aibadgr.com/api/v1"),
    api_key=os.getenv("AIBADGR_API_KEY")
)

response = client.chat.completions.create(
    model="premium",  # tier models: basic, normal, premium
    messages=[{"role": "user", "content": "Hello"}]
)

Includes tier model mappings: phi-3-mini (basic), mistral-7b (normal), llama3-8b-instruct (premium).


Essential Elements of an Effective PR Description Checklist
  • The purpose of the PR
  • The test plan
  • The test results
  • Documentation update (new framework integration doc)
  • Release notes update (not user-facing, docs-only change)

@github-actions
Copy link

👋 Hi! Thank you for contributing to the vLLM project.

💬 Join our developer Slack at https://slack.vllm.ai to discuss your PR in #pr-reviews, coordinate on features in #feat- channels, or join special interest groups in #sig- channels.

Just a reminder: PRs would not trigger full CI run by default. Instead, it would only run fastcheck CI which starts running only a small and essential subset of CI tests to quickly catch errors.

You ask your reviewers to trigger select CI tests on top of fastcheck CI.

Once the PR is approved and ready to go, your PR reviewer(s) can run CI to test the changes comprehensively before merging.

To run CI, PR reviewers can either: Add ready label to the PR or enable auto-merge.

If you have any questions, please reach out to us on Slack at https://slack.vllm.ai.

🚀

@chatgpt-codex-connector
Copy link

Codex usage limits have been reached for code reviews. Please check with the admins of this repo to increase the limits by adding credits.

@mergify
Copy link

mergify bot commented Dec 15, 2025

Documentation preview: https://vllm--30669.org.readthedocs.build/en/30669/

@mergify mergify bot added the documentation Improvements or additions to documentation label Dec 15, 2025
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces documentation for integrating AI Badgr as a framework. The new documentation is clear and follows the existing format for framework integrations. However, I've identified a significant correctness issue: the example commands use a model name that does not exist, which will cause them to fail. I've provided suggestions to replace it with a valid model name.

miguelmanlyx and others added 2 commits December 15, 2025 17:41
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Signed-off-by: miguelmanlyx <[email protected]>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Signed-off-by: miguelmanlyx <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant