Merge pull request #11 from artefactory-skaff/fix/dead-url

Update documentation URLs

.skaff/skaff.yaml

@@ -7,7 +7,7 @@ name: GenAI RAG indus kit
 owner: alexis.vialaret@artefact.com
 description: >
   Deploy production grade RAGs quickly, on any cloud.
-documentation_url: https://artefactory.github.io/skaff-rag-accelerator/
+documentation_url: https://artefactory-skaff.github.io/skaff-rag-accelerator/
 
 type: deployable   # deployable, knowldege pack
 lifecycle: prototype  # prototype, production

README.md

@@ -5,7 +5,7 @@ This is a starter kit to deploy a modularizable RAG locally or on the cloud (or
 
 ## Features
 
-- A configurable RAG setup based around Langchain ([Check out the configuration cookbook here](https://artefactory.github.io/skaff-rag-accelerator/cookbook/))
+- A configurable RAG setup based around Langchain ([Check out the configuration cookbook here](https://artefactory-skaff.github.io/skaff-rag-accelerator/cookbook/))
 - `RAG` and `RagConfig` python classes that manage components (vector store, llm, retreiver, ...)
 - A REST API based on Langserve + FastAPI to provide easy access to the RAG as a web backend
 - Optional API plugins for secure user authentication, session management, ...
@@ -17,7 +17,7 @@ This is a starter kit to deploy a modularizable RAG locally or on the cloud (or
 
 ## Quickstart
 
-This quickstart will guide you through the steps to serve the RAG and load a few documents. 
+This quickstart will guide you through the steps to serve the RAG and load a few documents.
 
 You will run both the back and front on your machine.
 
@@ -80,7 +80,7 @@ Right now the RAG does not have any documents loaded, you can use the notebook i
 
 To deep dive into under the hood, take a look at the documentation
 
-[On github pages](https://artefactory.github.io/skaff-rag-accelerator/)
+[On github pages](https://artefactory-skaff.github.io/skaff-rag-accelerator/)
 
 Or serve them locally:
 ```shell

backend/main.py

@@ -7,13 +7,13 @@
 from backend.rag_components.rag import RAG
 
 # Initialize a RAG as discribed in the config.yaml file
-# https://artefactory.github.io/skaff-rag-accelerator/backend/rag_ragconfig/
+# https://artefactory-skaff.github.io/skaff-rag-accelerator/backend/rag_ragconfig/
 rag = RAG(config=Path(__file__).parent / "config.yaml")
 chain = rag.get_chain()
 
 # Create a minimal RAG server based on langserve
 # Learn how to extend this configuration to add authentication and session management
-# https://artefactory.github.io/skaff-rag-accelerator/backend/plugins/plugins/
+# https://artefactory-skaff.github.io/skaff-rag-accelerator/backend/plugins/plugins/
 app = FastAPI(
     title="RAG Accelerator",
     description="A RAG-based question answering API",

docs/index.md

@@ -17,7 +17,7 @@ This is a starter kit to deploy a modularizable RAG locally or on the cloud (or
 
 ## Quickstart
 
-This quickstart will guide you through the steps to serve the RAG and load a few documents. 
+This quickstart will guide you through the steps to serve the RAG and load a few documents.
 
 You will run both the back and front on your machine.
 
@@ -79,7 +79,7 @@ Right now the RAG does not have any documents loaded, you can use the notebook i
 
 To deep dive into under the hood, take a look at the documentation
 
-[On github pages](https://artefactory.github.io/skaff-rag-accelerator/)
+[On github pages](https://artefactory-skaff.github.io/skaff-rag-accelerator/)
 
 Or serve them locally:
 ```shell

frontend/front.py

@@ -23,7 +23,7 @@ def browser_tab_title():
 
 def application_header():
     st.image(Image.open(ASSETS_PATH / "logo_title.jpeg"))
-    st.caption("Learn more about the RAG indus kit here: https://artefactory.github.io/skaff-rag-accelerator")
+    st.caption("Learn more about the RAG indus kit here: https://artefactory-skaff.github.io/skaff-rag-accelerator/")
 
 
 if __name__ == "__main__":
@@ -50,7 +50,6 @@ def application_header():
 
     # Once we have an authenticated session, show the chat interface
     if st.session_state.get("authenticated_session") is not None:
-
         # If the backend supports sessions, enable session navigation
         if backend_supports_sessions():
             initialize_state_variable("email", value="demo.user@email.com")  # With authentication, this will take the user's email

pyproject.toml

@@ -13,8 +13,8 @@ readme = "README.md"
 requires-python = ">=3.8"
 
 [project.urls]
-"Homepage" = "https://github.com/artefactory-fr/rag-as-a-service"
-"Documentation" = "https://artefactory-fr.github.io/rag-as-a-service"
+"Homepage" = "https://github.com/artefactory-skaff/skaff-rag-accelerator"
+"Documentation" = "https://artefactory-skaff.github.io/skaff-rag-accelerator/"
 
 [tool.setuptools]
 packages = ["lib", "config", "tests"]