doc: Add under construction banner to all pages

julep-ai · Oct 8, 2024 · a29434e · a29434e
1 parent d1e38e9
commit a29434e
Show file tree

Hide file tree

Showing 36 changed files with 254 additions and 0 deletions.
diff --git a/docs/api-reference/README.md b/docs/api-reference/README.md
@@ -1,3 +1,11 @@
+
+*****
+> ### This docs site is currently under construction although this github README below should suffice for now.
+
+![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
+*****
+
+
 # Agents API
 
 [![Run In Postman](https://run.pstmn.io/button.svg)](https://god.gw.postman.com/run-collection/33213061-a0a1e3a9-9681-44ae-a5c2-703912b32336?action=collection%2Ffork\&source=rip\_markdown\&collection-url=entityId%3D33213061-a0a1e3a9-9681-44ae-a5c2-703912b32336%26entityType%3Dcollection%26workspaceId%3D183380b4-f2ac-44ef-b018-1f65dfc8256b)

diff --git a/docs/api-reference/agents-api-1.md b/docs/api-reference/agents-api-1.md
@@ -2,6 +2,14 @@
 description: API for creating and modifying Users
 ---
 
+*****
+> ### This docs site is currently under construction although this github README below should suffice for now.
+
+![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
+*****
+
+
+
 # Users
 
 ## List all users

diff --git a/docs/api-reference/agents-api-2.md b/docs/api-reference/agents-api-2.md
@@ -2,6 +2,13 @@
 description: API for creating and modifying Sessions
 ---
 
+*****
+> ### This docs site is currently under construction although this github README below should suffice for now.
+
+![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
+*****
+
+
 # Sessions
 
 ## List sessions

diff --git a/docs/api-reference/agents-api-3.md b/docs/api-reference/agents-api-3.md
@@ -2,6 +2,13 @@
 description: API for accessing Agent Memories
 ---
 
+*****
+> ### This docs site is currently under construction although this github README below should suffice for now.
+
+![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
+*****
+
+
 # Memories
 
 ## Get an agent's memories

diff --git a/docs/api-reference/agents-api-4.md b/docs/api-reference/agents-api-4.md
@@ -2,6 +2,13 @@
 description: API for creating and modifying docs
 ---
 
+*****
+> ### This docs site is currently under construction although this github README below should suffice for now.
+
+![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
+*****
+
+
 # Docs
 
 ## Get all docs (for an agent or user)

diff --git a/docs/api-reference/agents-api-5.md b/docs/api-reference/agents-api-5.md
@@ -1,6 +1,13 @@
 # Tasks
 
 
+*****
+> ### This docs site is currently under construction although this github README below should suffice for now.
+
+![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
+*****
+
+
 
 {% hint style="info" %}
 Coming Soon

diff --git a/docs/api-reference/agents-api-6.md b/docs/api-reference/agents-api-6.md
@@ -1,5 +1,12 @@
 # Task Runs
 
+*****
+> ### This docs site is currently under construction although this github README below should suffice for now.
+
+![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
+*****
+
+
 {% hint style="info" %}
 **Coming soon.**
 {% endhint %}
diff --git a/docs/api-reference/agents-api.md b/docs/api-reference/agents-api.md
@@ -2,6 +2,13 @@
 description: API for creating and modifying Agents
 ---
 
+*****
+> ### This docs site is currently under construction although this github README below should suffice for now.
+
+![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
+*****
+
+
 # Agents
 
 ## List agents

diff --git a/docs/concepts/agents.md b/docs/concepts/agents.md
@@ -2,6 +2,13 @@
 description: A fundamental building block of an AI app built using Julep.
 ---
 
+*****
+> ### This docs site is currently under construction although this github README below should suffice for now.
+
+![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
+*****
+
+
 # 🤖 Agents
 
 ## What is an Agent?

diff --git a/docs/concepts/documents.md b/docs/concepts/documents.md
@@ -2,6 +2,13 @@
 description: Documents to be added for Retrieval Augmented Generation
 ---
 
+*****
+> ### This docs site is currently under construction although this github README below should suffice for now.
+
+![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
+*****
+
+
 # 📖 Documents
 
 A typical RAG application has the following components:

diff --git a/docs/concepts/sessions/README.md b/docs/concepts/sessions/README.md
@@ -2,6 +2,13 @@
 description: A conversation "session" between a user and an agent.
 ---
 
+*****
+> ### This docs site is currently under construction although this github README below should suffice for now.
+
+![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
+*****
+
+
 # 🔁 Sessions
 
 ## What is a Session?

diff --git a/docs/concepts/sessions/adaptive-context.md b/docs/concepts/sessions/adaptive-context.md
@@ -1,5 +1,12 @@
 # Adaptive Context ᴺᴱᵂ
 
+*****
+> ### This docs site is currently under construction although this github README below should suffice for now.
+
+![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
+*****
+
+
 ### What is Adaptive Context?
 
 Adaptive Context is a feature in Julep that intelligently manages the context size for long-running sessions. It allows users to continue adding messages to a session indefinitely without worrying about hitting context window limits or incurring excessive costs.

diff --git a/docs/concepts/users.md b/docs/concepts/users.md
@@ -2,6 +2,13 @@
 description: A real person or system that needs to interacts with the Agent in your app.
 ---
 
+*****
+> ### This docs site is currently under construction although this github README below should suffice for now.
+
+![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
+*****
+
+
 # 🙎 Users
 
 ## What is a User?

diff --git a/docs/explanation/chat_features.md b/docs/explanation/chat_features.md
@@ -1,5 +1,12 @@
 # Chat Features in Julep
 
+*****
+> ### This docs site is currently under construction although this github README below should suffice for now.
+
+![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
+*****
+
+
 Julep provides a robust chat system with various features for dynamic interaction with agents. Here's an overview of the key components and functionalities:
 
 ## Chat Input

diff --git a/docs/explanation/context_overflow.md b/docs/explanation/context_overflow.md
@@ -1,5 +1,12 @@
 # Context Overflow Handling in Julep
 
+*****
+> ### This docs site is currently under construction although this github README below should suffice for now.
+
+![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
+*****
+
+
 Julep provides mechanisms to handle scenarios where the context size grows beyond the `token_budget` or the model's input limit. The behavior is determined by the `context_overflow` setting:
 
 1. `null` (default): 

diff --git a/docs/explanation/core_concepts.md b/docs/explanation/core_concepts.md
@@ -1,5 +1,12 @@
 # Core Concepts in Julep
 
+*****
+> ### This docs site is currently under construction although this github README below should suffice for now.
+
+![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
+*****
+
+
 Julep is a powerful backend system for managing agent execution. It provides several key components that work together to create flexible and intelligent applications. Here are the core concepts:
 
 ## Agent

diff --git a/docs/explanation/default_system_template.md b/docs/explanation/default_system_template.md
@@ -1,5 +1,12 @@
 # Default System Template in Julep
 
+*****
+> ### This docs site is currently under construction although this github README below should suffice for now.
+
+![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
+*****
+
+
 Julep uses a default system template for sessions when a custom one is not provided. This template is written in Jinja2 and incorporates various elements from the agent, user, and session context. Here's a breakdown of the template:
 
 ```jinja

diff --git a/docs/explanation/execution_state_machine.md b/docs/explanation/execution_state_machine.md
@@ -1,5 +1,12 @@
 # Execution State Machine in Julep
 
+*****
+> ### This docs site is currently under construction although this github README below should suffice for now.
+
+![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
+*****
+
+
 In Julep, an Execution represents an instance of a Task that has been started with some input. The Execution follows a specific state machine model, ensuring consistent and predictable behavior throughout its lifecycle.
 
 ## Execution States

diff --git a/docs/explanation/metadata_precedence.md b/docs/explanation/metadata_precedence.md
@@ -1,5 +1,12 @@
 # Metadata Precedence in Julep
 
+*****
+> ### This docs site is currently under construction although this github README below should suffice for now.
+
+![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
+*****
+
+
 In Julep, several objects can have `metadata` added to them:
 - Agent
 - User

diff --git a/docs/explanation/multi_agent_sessions.md b/docs/explanation/multi_agent_sessions.md
@@ -1,5 +1,12 @@
 # Multi-Agent Sessions in Julep
 
+*****
+> ### This docs site is currently under construction although this github README below should suffice for now.
+
+![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
+*****
+
+
 Julep supports different types of sessions based on the number of agents and users involved. This flexibility allows for complex interactions and use cases.
 
 ## Types of Sessions

diff --git a/docs/explanation/task_workflows.md b/docs/explanation/task_workflows.md
@@ -1,5 +1,12 @@
 # Task Workflows in Julep
 
+*****
+> ### This docs site is currently under construction although this github README below should suffice for now.
+
+![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
+*****
+
+
 Tasks in Julep are powerful, Github Actions-style workflows that define long-running, multi-step actions. They allow for complex operations by defining steps and have access to all Julep integrations.
 
 ## Task Structure

diff --git a/docs/explanation/tool_integration.md b/docs/explanation/tool_integration.md
@@ -1,5 +1,12 @@
 # Tool Integration in Julep
 
+*****
+> ### This docs site is currently under construction although this github README below should suffice for now.
+
+![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
+*****
+
+
 Julep provides a flexible system for integrating various types of tools that agents can use during interactions. These tools enable agents to perform actions, retrieve information, or interact with external systems.
 
 ## Types of Tools

diff --git a/docs/how-to-guides/customizing_tasks.md b/docs/how-to-guides/customizing_tasks.md
@@ -1,5 +1,12 @@
 # Customizing Tasks
 
+*****
+> ### This docs site is currently under construction although this github README below should suffice for now.
+
+![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
+*****
+
+
 This guide covers how to define and customize tasks for agents in Julep.
 
 ## Creating a Basic Task

diff --git a/docs/how-to-guides/handling_executions.md b/docs/how-to-guides/handling_executions.md
@@ -1,5 +1,12 @@
 # Handling Executions
 
+*****
+> ### This docs site is currently under construction although this github README below should suffice for now.
+
+![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
+*****
+
+
 This guide covers how to manage and monitor task executions in Julep.
 
 ## Starting an Execution

diff --git a/docs/how-to-guides/managing_users.md b/docs/how-to-guides/managing_users.md
@@ -1,5 +1,12 @@
 # Managing Users
 
+*****
+> ### This docs site is currently under construction although this github README below should suffice for now.
+
+![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
+*****
+
+
 This guide covers how to create, update, and delete users in Julep.
 
 ## Creating a User

diff --git a/docs/how-to-guides/using_chat_features.md b/docs/how-to-guides/using_chat_features.md
@@ -1,5 +1,12 @@
 # Using Chat Features
 
+*****
+> ### This docs site is currently under construction although this github README below should suffice for now.
+
+![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
+*****
+
+
 This guide covers how to use the chat features in Julep for dynamic interactions with agents.
 
 ## Starting a Chat Session

diff --git a/docs/introduction/getting_started.md b/docs/introduction/getting_started.md
@@ -1,5 +1,12 @@
 # Getting Started with Julep
 
+*****
+> ### This docs site is currently under construction although this github README below should suffice for now.
+
+![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
+*****
+
+
 This guide will help you set up and start using the Julep API.
 
 ## Prerequisites

diff --git a/docs/introduction/overview.md b/docs/introduction/overview.md
@@ -1,5 +1,12 @@
 # Overview of Julep
 
+*****
+> ### This docs site is currently under construction although this github README below should suffice for now.
+
+![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
+*****
+
+
 Julep is a powerful backend system for managing agent execution and interactions. It provides a comprehensive set of features for creating and managing agents, users, sessions, tools, documents, tasks, and executions.
 
 ## Key Features

diff --git a/docs/reference/api_endpoints/agent_endpoints.md b/docs/reference/api_endpoints/agent_endpoints.md
@@ -1,5 +1,12 @@
 # Agent Endpoints
 
+*****
+> ### This docs site is currently under construction although this github README below should suffice for now.
+
+![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
+*****
+
+
 This document provides a reference for all Agent API endpoints in Julep.
 
 ## List Agents

diff --git a/docs/reference/api_endpoints/doc_endpoints.md b/docs/reference/api_endpoints/doc_endpoints.md
@@ -1,5 +1,12 @@
 # Doc Endpoints
 
+*****
+> ### This docs site is currently under construction although this github README below should suffice for now.
+
+![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
+*****
+
+
 This document provides a reference for all Doc API endpoints in Julep.
 
 ## List Docs for a User