Skip to content

docs: add chat/completions rag docs and split install/api docs #1334

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 4 commits into from
Aug 6, 2025
Merged

docs: add chat/completions rag docs and split install/api docs #1334

merged 4 commits into from
Aug 6, 2025

Conversation

bfoley13
Copy link
Collaborator

Reason for Change:
Adding docs for rag /v1/chat/completions api

@kaito-pr-agent Kaito PR Agent
Copy link

Title

Add detailed RAG API documentation and update sidebar

Description

  • Added detailed RAG API documentation in rag-api.md

  • Updated sidebar to include RAG category with API link

  • Moved API details from rag.md to rag-api.md

Changes walkthrough 📝

Relevant files
Documentation
sidebars.js
Update sidebar with RAG category                                                 

website/sidebars.js

  • Created a nested category for RAG in the Features section
  • Added a link to the new rag-api.md document
    		• +11/-1   
    rag-api.md
    Add RAG API documentation                                                               

    website/docs/rag-api.md

  • Added comprehensive documentation for RAG API including index
    management, document operations, and query functionalities
    		• +431/-0 
    rag.md
    Remove API details from rag.md                                                     

    website/docs/rag.md

  • Removed API details from rag.md
  • Kept introduction and setup instructions
    		• +4/-349 
    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
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Duplicate Content

    The content related to API definitions and examples has been moved to a new file rag-api.md, but the same content still exists in rag.md. This duplication should be resolved to avoid redundancy.

     
    After you create your YAML configuration, run:
```sh
kubectl apply -f examples/RAG/kaito_ragengine_phi_3.yaml
    
</details>

</td></tr>
</table>

    @kaito-pr-agent Kaito PR Agent
    Copy link

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Impact
    General
    Remove unnecessary link property

    Remove the link property since it is not necessary for a category with sub-items.
    The category itself will link to the first item in the list.

    website/sidebars.js [47-57]

     {
     type: 'category',
     label: 'Retrieval-Augmented Generation (RAG)',
-    link: {
-        type: 'doc',
-        id: 'rag',
-    },
     items: [
         'rag-api',
     ],
 },
    Suggestion importance[1-10]: 5

    __

    Why: The link property is not necessary for a category with sub-items, as the category itself links to the first item in the list. This simplifies the configuration slightly.

    		Low
    Fix typo in RAG Engine

    Correct the typo RAGEngine to RAG Engine for consistency and clarity.

    website/docs/rag-api.md [5]

    -A **RAGEngine index** is a logical collection that organizes and stores your documents for retrieval-augmented generation workflows. The relationship between indexes, documents, and document nodes is as follows:
+A **RAG Engine index** is a logical collection that organizes and stores your documents for retrieval-augmented generation workflows. The relationship between indexes, documents, and document nodes is as follows:
    Suggestion importance[1-10]: 3

    __

    Why: Correcting the typo improves the readability and consistency of the documentation.

    		Low
    Fix typo and capitalize RAG Engine

    Correct the typo generatoin to generation and ensure consistent capitalization of
    RAG Engine.

    website/docs/rag.md [5]

    -This document presents how to use the KAITO `ragengine` Custom Resource Definition (CRD) for retrieval-augumented generatoin workflow.
+This document presents how to use the KAITO `RAG Engine` Custom Resource Definition (CRD) for retrieval-augmented generation workflow.
    Suggestion importance[1-10]: 3

    __

    Why: Correcting the typo and ensuring consistent capitalization improves the readability and consistency of the documentation.

    		Low

    @chewong chewong mentioned this pull request Jul 31, 2025
    Closed
    1 task
    @zhuangqh zhuangqh added this to the 0.5.2 milestone Aug 4, 2025
    @zhuangqh zhuangqh removed this from the 0.5.2 milestone Aug 6, 2025
    @Fei-Guo Fei-Guo merged commit ca4b6e2 into kaito-project:main Aug 6, 2025
    15 of 16 checks passed
    farooqameen pushed a commit to farooqameen/kaito that referenced this pull request Aug 7, 2025
    @bfoley13 @farooqameen
    docs: add chat/completions rag docs and split install/api docs (kaito…
    8ecebe4 
    …-project#1334)

**Reason for Change**:
Adding docs for rag /v1/chat/completions api
    farooqameen pushed a commit to farooqameen/kaito that referenced this pull request Aug 7, 2025
    @bfoley13 @farooqameen
    docs: add chat/completions rag docs and split install/api docs (kaito…
    c811134 
    …-project#1334)

**Reason for Change**:
Adding docs for rag /v1/chat/completions api
    farooqameen pushed a commit to farooqameen/kaito that referenced this pull request Aug 7, 2025
    @bfoley13 @farooqameen
    docs: add chat/completions rag docs and split install/api docs (kaito…
    ec903a5 
    …-project#1334)

**Reason for Change**:
Adding docs for rag /v1/chat/completions api
    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

    @Fei-Guo Fei-Guo Fei-Guo approved these changes

    @chewong chewong Awaiting requested review from chewong chewong 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.
    3 participants
    @bfoley13 @zhuangqh @Fei-Guo