From 19f504e9e267759c489af287049d479176730d27 Mon Sep 17 00:00:00 2001 From: Francisco Arceo Date: Tue, 1 Apr 2025 06:50:04 -0600 Subject: [PATCH] docs: Updating docs to source from CONTRIBUTING.md (#1850) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit # What does this PR do? Another for https://github.com/meta-llama/llama-stack/issues/1815 This links the `CONTRIBUTING.md` file directly so that we don't have to maintain two different files. Also I updated the title for RAG under Building AI Applications. ## Changes Look of what the Contributing page looks like, proof it sources directly from the markdown file. ![Screenshot 2025-04-01 at 12 43 51 AM](https://github.com/user-attachments/assets/f7021d29-eec3-44ad-a5b3-55c4480ea9ac) --------- Signed-off-by: Francisco Javier Arceo --- docs/source/building_applications/rag.md | 2 +- docs/source/contributing/index.md | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/source/building_applications/rag.md b/docs/source/building_applications/rag.md index c3d02d7dc..fd11d824f 100644 --- a/docs/source/building_applications/rag.md +++ b/docs/source/building_applications/rag.md @@ -1,4 +1,4 @@ -## Using Retrieval Augmented Generation (RAG) +## Retrieval Augmented Generation (RAG) RAG enables your applications to reference and recall information from previous interactions or external documents. diff --git a/docs/source/contributing/index.md b/docs/source/contributing/index.md index 8f89ea9f2..8e4f5e867 100644 --- a/docs/source/contributing/index.md +++ b/docs/source/contributing/index.md @@ -1,14 +1,14 @@ -# Contributing to Llama Stack -Start with the [Contributing Guide](https://github.com/meta-llama/llama-stack/blob/main/CONTRIBUTING.md) for some general tips. This section covers a few key topics in more detail. +```{include} ../../../CONTRIBUTING.md +``` + +See the [Adding a New API Provider](new_api_provider.md) which describes how to add new API providers to the Stack. + -- [Adding a New API Provider](new_api_provider.md) describes adding new API providers to the Stack. -- [Testing Llama Stack](testing.md) provides details about the testing framework and how to test providers and distributions. ```{toctree} :maxdepth: 1 :hidden: new_api_provider -testing ```