README

[yuhongsun96]

Description

README

How Has This Been Tested?

[Describe the tests you ran to verify your changes]

Backporting (check the box to trigger backport action)

Note: You have to check that the action passes, otherwise resolve the conflicts manually and tag the patches.

• This PR should be backported (make sure to check that the backport attempt succeeds)
• [Optional] Override Linear Check

---

Summary by cubic

Refreshes the README with a clearer product intro, a concise features overview, and a one-line install command to speed up onboarding. Also streamlines deployment guidance and updates links/assets for accuracy.

• Documentation
  • Updated tagline and intro; clarified LLM compatibility and airgapped support.
  • Added quickstart install script and restructured deployment guides (Docker, Kubernetes, Terraform, cloud).
  • Introduced a compact Features section (Agents, Web Search, RAG, Connectors, Actions/MCP, Code Interpreter, Image Generation, Collaboration).
  • Replaced long connector list with a single link to the connectors overview.
  • Added Onyx Cloud tip for instant try-out; refreshed demo assets and doc links.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
internal-search	Ready	Preview	Comment	Sep 25, 2025 3:35am

[greptile-apps]

Greptile Overview

Summary

This PR completely restructures the README.md file to provide a more streamlined and focused presentation of Onyx. The changes include simplifying the tagline from "Open Source Gen-AI + Enterprise Search" to "Open Source AI Platform", consolidating the feature descriptions into a cleaner bullet-point format, and adding a prominent one-line installation command. The update removes some detailed content like video demonstrations, the full connector list, and lengthy feature explanations in favor of a more concise overview that directs users to the documentation for complete details.

Key improvements:

• More prominent deployment instructions with single-command install
• Better organized features section with clear categorization
• Simplified messaging that's easier to scan
• Removal of redundant content and videos that may have been outdated

Minor concern: The ONYX_METADATA comment was removed, which may be used by automated tooling.

Confidence Score: 4/5

• This PR is safe to merge with minimal risk - it only modifies documentation
• High confidence as this is purely a documentation improvement with better organization and presentation. Only minor concern is the removed metadata comment which may be used by tooling.
• No files require special attention - single documentation file with straightforward changes

Important Files Changed

File Analysis

Filename	Score	Overview
README.md	4/5	Major restructuring of README with improved presentation, but removed some technical details and removed metadata comment

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant Repo as Repository
    participant Users as End Users
    participant Tools as Documentation Tools
    
    Dev->>Repo: Updates README.md structure
    Dev->>Repo: Removes ONYX_METADATA comment
    Dev->>Repo: Simplifies tagline and descriptions
    Dev->>Repo: Reorganizes content sections
    
    Users->>Repo: View updated README
    Repo->>Users: Shows streamlined presentation
    Users->>Repo: Follow one-line install command
    
    Tools->>Repo: Look for ONYX_METADATA
    Repo-->>Tools: Metadata no longer available
    Note over Tools: Potential impact on automated processes

Loading

_{1 file reviewed, 1 comment}

_{Edit Code Review Agent Settings | Greptile}

[greptile-apps]

style: The ONYX_METADATA comment was removed. Check if this metadata is used by documentation systems or other tooling, as removing it could break automated processes.

[cubic-dev-ai]

No issues found across 1 file