updated

CyVerse-learning-materials · Oct 30, 2024 · 5c094ca · 5c094ca
1 parent af2784c
commit 5c094ca
Show file tree

Hide file tree

Showing 24 changed files with 138 additions and 29 deletions.
diff --git a/docs/advanced-topics/api-token-vscode.md b/docs/advanced-topics/api-token-vscode.md
diff --git a/docs/advanced-topics/api-token.md b/docs/advanced-topics/api-token.md
diff --git a/docs/api/api-token-android.md b/docs/api/api-token-android.md
@@ -0,0 +1 @@
+# Examples of using your AI-VERDE API Token in Android
diff --git a/docs/api/api-token-jupyter.md b/docs/api/api-token-jupyter.md
@@ -0,0 +1 @@
+# Examples of using your AI-VERDE API Token in Jupyter
diff --git a/docs/api/api-token-macos.md b/docs/api/api-token-macos.md
@@ -0,0 +1 @@
+# Examples of using your AI-VERDE API Token in MacOS
diff --git a/docs/api/api-token-vscode.md b/docs/api/api-token-vscode.md
@@ -0,0 +1 @@
+# Examples of using your AI-VERDE API Token in VSCode
diff --git a/docs/api/api-token-windows.md b/docs/api/api-token-windows.md
@@ -0,0 +1 @@
+# Examples of using your AI-VERDE API Token in Windows Desktop
diff --git a/docs/api/api-token.md b/docs/api/api-token.md
@@ -0,0 +1 @@
+# Obtaining your AI-VERDE API Token
diff --git a/docs/api/index.md b/docs/api/index.md
@@ -0,0 +1 @@
+# Introduction to AI-VERDE API
diff --git a/docs/assets/cactuar-avatar.png b/docs/assets/cactuar-avatar.png
diff --git a/docs/assets/chat-cactus.png b/docs/assets/chat-cactus.png
diff --git a/docs/assets/contact_support.png b/docs/assets/contact_support.png
diff --git a/docs/assets/course_chat.png b/docs/assets/course_chat.png
diff --git a/docs/assets/course_chat_button.png b/docs/assets/course_chat_button.png
diff --git a/docs/chat-history.md b/docs/chat-history.md
@@ -0,0 +1 @@
+# Using AI-VERDE Chat History
diff --git a/docs/advanced-topics/api-token-jupyter.md → docs/faq.md b/docs/advanced-topics/api-token-jupyter.md → docs/faq.md
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -0,0 +1,58 @@
+# Getting Started with AI-VERDE Chat
+
+This guide will help you get up and running quickly, so you can start making the most out of your experience with our AI-VERDE Chat.
+
+## 1. Sign In
+
+Before using the AI-VERDE chat interface, ensure you are signed in with your institution's credentials.
+
+!!! Note
+    AI-VERDE is currently only available to the University of Arizona community
+
+1. Go to [https://chat.cyverse.ai/](https://chat.cyverse.ai/){target=_new}.
+2. Click **Sign In** button.
+3. Select your institutional provider
+4. Click on the **Log On** button.
+5. Login using your institutional login process
+6. Click **Sign In**.
+
+## 2. Select Your Team or Course
+
+Once signed in, find your course or team card and click on the chat button.
+
+![course chat button](assets/course_chat_button.png){: style="width:50%"}
+
+## 2. Ask Your First Question
+
+After clicking on the course or team card, the page will show a text box where you can interact with AI-VERDE. You can then:
+
+- **Type a question** directly in the chat box (e.g., "Why is the sky blue?").
+- **Press Send** to submit.
+- **Receive a Response** within seconds, tailored to your query.
+
+![course chat](assets/course_chat.png){: style="width:100%"}
+
+## 3. Continue the Conversation
+
+You can ask follow-up questions for further clarification, request examples, or explore related topics.
+
+#### Example:
+
+1. **Initial Question**: "Explain the concept of ecosystems in biology."
+2. **Follow-Up**: "Can you provide examples of different types of ecosystems?"
+3. **Further Detail**: "How does biodiversity impact ecosystem stability?"
+
+---
+
+## Tips for Using the Chat Interface
+
+- **Be Specific**: Detailed questions yield the best responses.
+- **Explore Broadly**: If your team or course is not targeting specific documents, you can ask about a wide range of topics or request explanations for academic concepts.
+- **Engage in Multi-Step Conversations**: If you need deeper insights, use follow-up questions to refine the responses.
+
+## Support and Feedback
+
+If you encounter issues or have suggestions, reach out to our support team using the built-in support chat:
+
+![support button](assets/contact_support.png){: style="width:50%"}
+
diff --git a/docs/index.md b/docs/index.md
@@ -1 +1,17 @@
-# Verde Manual & Resource Center
+# Welcome!
+
+## Introduction
+
+Welcome to the AI-VERDE, an open source platform that facilitates access to commercial and on-premise LLMs with budget and access controls. AI-VERDE stands for "AI Virtual Explorer for Research, Discovery, and Education". There are two pieces to AI-VERDE, the AI-VERDE chat interface and the [AI-VERDE API](api/index.md) (application programming interface)
+
+Our chat interface provides you with an interactive, AI-powered assistant designed to enhance your learning, research, and teaching experiences. Using cutting-edge language model technology from OpenAI, this interface allows you to engage with an advanced AI assistant capable of answering questions, offering explanations, and assisting with various tasks in real time.
+
+## Key Features:
+
+- **Interactive Q&A**: Simply type your question, and the assistant will provide clear, concise answers on a wide range of topics.
+- **Designed for small teams and courses**: Use AI-VERDE for small teams, labs, and courses
+- **Bring Your Own (BYO) LLM**: Instructors and team leads can optionally bring their own commercial or third-party LLM to AI-VERDE or use CyVerse's on-premise LLMs 
+- **Built for Retrieval-Augmented Generation (RAG)**: Instructors and team leads can optionally configure AI-VERDE to provide answers strictly from source documents
+- **Budgets management and cost savings**: If you're using commercial services, tokens cost money. Use AI-VERDE to control model access, set budgets at the course or team, and to set budgets per individual.
+- **Built-in Guardrails**: Ensure the responsible, safe, and effective use of AI-VERDE within your team and course
+
diff --git a/docs/selecting-your-course.md b/docs/selecting-your-course.md
diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css
@@ -1,4 +1,6 @@
-:root {
-    --md-primary-fg-color:  #0C234B;
-    --md-accent-fg-color:   #AB0520;
+[data-md-color-scheme="aiverde"] {
+    --md-primary-fg-color:  #15224b;
+    --md-accent-fg-color:   #2bb575;
+    /* --md-primary-fg-color--light: #2bb575;
+    --md-primary-fg-color--dark:  #15224b;   */
   }
diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md
diff --git a/docs/using-chat.md b/docs/using-chat.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,14 +1,14 @@
-site_name: Verde Manual & Resource Center
-site_description: This site serves as the manual for Verde, our classroom chatbot, providing guides and guidelines for effective use and troubleshooting.
+site_name: AI-VERDE Manual & Resource Site
+site_description: This site serves as the manual and resource site for AI-VERDE (aka VERDE), our classroom chatbot, providing guides for using the service.
 site_author: CyVerse and Data Science Institute
 site_url: https://verde-docs.cyverse.ai
 
 # Repository
-repo_name: Verde Docs
+repo_name: AI-VERDE Docs
 repo_url: https://github.com/CyVerse-learning-materials/verde-docs
 edit_uri: edit/main/docs/
 # Copyright
-copyright: 'Copyright &copy; 2023 - 2024 CyVerse'
+copyright: 'Copyright &copy; 2024 CyVerse'
 
 
 # Configuration
@@ -39,25 +39,48 @@ theme:
 
   # Palette and theme (uses personalized colours)
   language: en
+
+    # Palette toggle for light mode
   palette:
-    primary: custom
-    accent: custom
+    - media: "(prefers-color-scheme: light)"
+      scheme: green
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+
+    # Palette toggle for dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+
+
+  # palette:
+  #   primary: custom
+  #   accent: custom
+  logo: assets/chat-cactus.png
   icon:
     logo: material/cogs
   favicon: material/cogs
 
 # Page tree
 nav:
-  - Home:
+  - AI-VERDE Chat:
     - Welcome: index.md
     - Getting Started: getting-started.md
-    - Selecting Your Course: selecting-your-course.md
-    - Using Chat: using-chat.md
-    - Troubleshooting: troubleshooting.md
-  - Advanced Topics:
-    - Obtaining an your Verde API Token: advanced-topics/api-token.md
-    - Example of using your Verde API Token in Jupyter: advanced-topics/api-token-jupyter.md
-    - Example of using your Verde API Token in VSCode: advanced-topics/api-token-vscode.md
+    - Chat History: chat-history.md
+  - AI-VERDE API:
+    - What is the AI-VERDE API: api/index.md
+    - Obtaining your AI-VERDE API Token: api/api-token.md
+    - Examples of using your AI-VERDE API Token in Jupyter: api/api-token-jupyter.md
+    - Examples of using your AI-VERDE API Token in VSCode: api/api-token-vscode.md
+    - Examples of using your AI-VERDE API Token in Windows Desktop: api/api-token-windows.md
+    - Examples of using your AI-VERDE API Token in MacOS: api/api-token-anroid.md
+    - Examples of using your AI-VERDE API Token in Android: api/api-token-macos.md
+
+  - FAQ:
+    - FAQ: faq.md
   - For Instructors (and staff):
     - Getting Started: instructors/getting-started.md
     - Creating a Course: instructors/creating-a-course.md
@@ -86,6 +109,7 @@ markdown_extensions:
   - footnotes
   - meta
   - md_in_html
+  # - open-in-new-tab
   - toc:
       permalink: true
       title: On this page
@@ -97,7 +121,7 @@ markdown_extensions:
   - pymdownx.critic
   - pymdownx.details
   - pymdownx.emoji:
-      emoji_index: !!python/name:materialx.emoji.twemoji
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
       emoji_generator: !!python/name:materialx.emoji.to_svg
   - pymdownx.highlight
   - pymdownx.inlinehilite

diff --git a/requirements.txt b/requirements.txt
@@ -1,16 +1,16 @@
-bump2version
-coverage
-flake8
-grip
+# bump2version
+# coverage
+# flake8
+# grip
 ipykernel
 livereload
 nbconvert>=7
-pip
-sphinx
-tox
-twine
-watchdog
-wheel
+# pip
+# sphinx
+# tox
+# twine
+# watchdog
+# wheel
 mkdocs-git-revision-date-plugin 
 mkdocs-jupyter 
 mkdocs-material 
@@ -20,6 +20,7 @@ mkdocstrings-crystal
 mkdocstrings-python-legacy
 #pygments>=2.10,<2.12
 #pymdown-extensions<9.4
+mkdocs-open-in-new-tab==1.0.3
 
 # Requirements for core
 jinja2>=3.0.2
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		# Examples of using your AI-VERDE API Token in Android