Update documentation with enhanced model information and system prompt templates

- Add OpenRouter model links for easy access to model details
- Highlight google/gemma-3-27b-it as open-source sustainable option
- Add copy-pasteable system prompt templates for common use cases
- Include templated Q&A assistant with Psychology 101 example
- Streamline deployment section assuming users have API keys
- Add visual guide reference for HuggingFace secret configuration
- Update model comments in app.py for better clarity

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>

app.py

@@ -296,11 +296,11 @@ if __name__ == "__main__":
 
 # Available models
 MODELS = [
-    "google/gemma-3-27b-it",
-    "google/gemini-2.0-flash-001",
-    "mistralai/mistral-medium",
-    "openai/gpt-4o-nano",
-    "anthropic/claude-3.5-haiku"
+    "google/gemma-3-27b-it",          # Open-source, sustainable option
+    "google/gemini-2.0-flash-001",    # Fast, reliable, general tasks
+    "mistralai/mistral-medium",       # Good for technical topics
+    "openai/gpt-4o-nano",            # Balanced performance and cost
+    "anthropic/claude-3.5-haiku"     # Complex reasoning and analysis
 ]
 
 def fetch_url_content(url):
@@ -1073,8 +1073,8 @@ def remove_chat_urls(count):
     else:
         return (gr.update(), gr.update(), gr.update(), gr.update(), count)
 
-def toggle_research_assistant(enable_research):
-    """Toggle visibility of research assistant detailed fields and disable custom categories"""
+def toggle_research_assistant(enable_research, current_custom_enabled):
+    """Toggle visibility of research assistant detailed fields"""
     if enable_research:
         combined_prompt = "You are a research assistant that provides link-grounded information through web fetching. Use MLA documentation for parenthetical citations and bibliographic entries. This assistant is designed for students and researchers conducting academic inquiry. Your main responsibilities include: analyzing academic sources, fact-checking claims with evidence, providing properly cited research summaries, and helping users navigate scholarly information. Ground all responses in provided URL contexts and any additional URLs you're instructed to fetch. Never rely on memory for factual claims."
         return (
@@ -1085,8 +1085,8 @@ def toggle_research_assistant(enable_research):
             gr.update(value="Your main responsibilities include: analyzing academic sources, fact-checking claims with evidence, providing properly cited research summaries, and helping users navigate scholarly information."),
             gr.update(value="Ground all responses in provided URL contexts and any additional URLs you're instructed to fetch. Never rely on memory for factual claims."),
             gr.update(value=True),  # Enable dynamic URL fetching for research template
-            gr.update(value=False),  # Force disable custom categories checkbox
-            gr.update(visible=False)  # Force hide custom categories fields
+            gr.update(visible=False),  # Hide custom categories fields
+            gr.update(value=False)  # Disable custom categories checkbox
         )
     else:
         return (
@@ -1097,8 +1097,8 @@ def toggle_research_assistant(enable_research):
             gr.update(value=""),
             gr.update(value=""),
             gr.update(value=False),  # Disable dynamic URL setting
-            gr.update(value=False),  # Ensure custom categories stays disabled
-            gr.update(visible=False)  # Ensure custom categories fields stay hidden
+            gr.update(visible=not current_custom_enabled),  # Show custom fields if custom was enabled
+            gr.update()  # Keep custom categories checkbox as is
         )
 
 def update_system_prompt_from_fields(role_purpose, intended_audience, key_tasks, additional_context):
@@ -1116,19 +1116,19 @@ def update_system_prompt_from_fields(role_purpose, intended_audience, key_tasks,
     combined = " ".join(parts)
     return gr.update(value=combined)
 
-def toggle_custom_categories(enable_custom):
-    """Toggle visibility of custom categories fields and disable research assistant"""
+def toggle_custom_categories(enable_custom, current_research_enabled):
+    """Toggle visibility of custom categories fields"""
     if enable_custom:
         return (
             gr.update(visible=True),  # Show custom categories fields
-            gr.update(value=False),  # Force disable research assistant checkbox
-            gr.update(visible=False)  # Force hide research assistant fields
+            gr.update(visible=False),  # Hide research assistant fields
+            gr.update(value=False)  # Disable research assistant checkbox
         )
     else:
         return (
             gr.update(visible=False),  # Hide custom categories fields
-            gr.update(value=False),  # Ensure research assistant stays disabled
-            gr.update(visible=False)  # Ensure research assistant fields stay hidden
+            gr.update(visible=not current_research_enabled),  # Show research fields if research was enabled
+            gr.update()  # Keep research assistant checkbox as is
         )
 
 # Create Gradio interface with proper tab structure
@@ -1382,15 +1382,15 @@ with gr.Blocks(title="Chat U/I Helper") as demo:
             # Connect the research assistant checkbox
             enable_research_assistant.change(
                 toggle_research_assistant,
-                inputs=[enable_research_assistant],
-                outputs=[research_detailed_fields, system_prompt, role_purpose, intended_audience, key_tasks, additional_context, enable_dynamic_urls, enable_custom_categories, custom_categories_fields]
+                inputs=[enable_research_assistant, enable_custom_categories],
+                outputs=[research_detailed_fields, system_prompt, role_purpose, intended_audience, key_tasks, additional_context, enable_dynamic_urls, custom_categories_fields, enable_custom_categories]
             )
             
             # Connect the custom categories checkbox
             enable_custom_categories.change(
                 toggle_custom_categories,
-                inputs=[enable_custom_categories],
-                outputs=[custom_categories_fields, enable_research_assistant, research_detailed_fields]
+                inputs=[enable_custom_categories, enable_research_assistant],
+                outputs=[custom_categories_fields, research_detailed_fields, enable_research_assistant]
             )
             
             # Connect research assistant fields to update main system prompt

support_docs.py

@@ -40,10 +40,11 @@ def create_support_docs():
             - Will appear in the HuggingFace Space listing and at the top of your chat
             
             **Model Selection**
-            - **google/gemini-2.0-flash-001**: Fast, reliable, good for general tasks
-            - **anthropic/claude-3.5-haiku**: Great for complex reasoning and analysis
-            - **openai/gpt-4o-nano**: Balanced performance and cost
-            - **mistralai/mistral-medium**: Good for technical topics
+            - **[google/gemma-3-27b-it](https://openrouter.ai/models/google/gemma-3-27b-it)**: Open-source, sustainable option with excellent performance
+            - **[google/gemini-2.0-flash-001](https://openrouter.ai/models/google/gemini-2.0-flash-001)**: Fast, reliable, good for general tasks
+            - **[mistralai/mistral-medium](https://openrouter.ai/models/mistralai/mistral-medium)**: Good for technical topics
+            - **[openai/gpt-4o-nano](https://openrouter.ai/models/openai/gpt-4o-nano)**: Balanced performance and cost
+            - **[anthropic/claude-3.5-haiku](https://openrouter.ai/models/anthropic/claude-3.5-haiku)**: Great for complex reasoning and analysis
             
             **API Key Variable Name**
             - Default: `OPENROUTER_API_KEY`
@@ -81,13 +82,36 @@ def create_support_docs():
               - **Key Tasks**: What specific capabilities should it have?
               - **Additional Context**: Extra instructions or constraints
             
-            **Example System Prompts:**
+            ### Copy-Pasteable System Prompts
+            
+            **Biology Course Assistant:**
+            ```
+            You are a biology teaching assistant for undergraduate students. Help with concepts, lab procedures, and study questions. Always explain complex topics in simple terms and encourage critical thinking. Focus on helping students understand fundamental biological processes and prepare for exams.
+            ```
+            
+            **Research Writing Helper:**
+            ```
+            You are a research writing assistant. Help students with citation formatting, argument structure, and source analysis. Focus on academic writing standards and proper documentation. Guide students through the research process from topic selection to final paper submission.
+            ```
+            
+            **Course Q&A Assistant (Template):**
+            ```
+            You are a knowledgeable academic assistant for [COURSE NAME] students. Provide clear, evidence-based answers about [SUBJECT AREA] while encouraging deeper engagement through follow-up questions. Use accessible language appropriate for [STUDENT LEVEL]. Keep responses concise (under 100 words) with bullet points when helpful. End each response with a thought-provoking question or real-world connection that encourages students to think critically about the topic and explore related concepts.
+            ```
+            
+            **Psychology 101 Example:**
+            ```
+            You are a knowledgeable academic research assistant for a Psychology 101 class. Provide students with clear, evidence-based answers about psychology topics while encouraging deeper engagement through follow-up questions. Use accessible language appropriate for introductory students. Keep responses concise (under 100 words) with bullet points when helpful. End each response with a thought-provoking question or real-world example that encourages students to think critically about how psychology concepts apply to everyday life.
             ```
-            Biology Course Assistant:
-            "You are a biology teaching assistant for undergraduate students. Help with concepts, lab procedures, and study questions. Always explain complex topics in simple terms and encourage critical thinking."
             
-            Research Writing Helper:
-            "You are a research writing assistant. Help students with citation formatting, argument structure, and source analysis. Focus on academic writing standards and proper documentation."
+            **Technical Support Helper:**
+            ```
+            You are a technical support assistant specializing in software tools and programming concepts. Provide step-by-step guidance, troubleshoot common issues, and explain technical concepts in accessible language. Always include examples when possible.
+            ```
+            
+            **Research Assistant (Pre-configured Template):**
+            ```
+            You are a research assistant that provides link-grounded information through web fetching. Use MLA documentation for parenthetical citations and bibliographic entries. This assistant is designed for students and researchers conducting academic inquiry. Your main responsibilities include: analyzing academic sources, fact-checking claims with evidence, providing properly cited research summaries, and helping users navigate scholarly information. Ground all responses in provided URL contexts and any additional URLs you're instructed to fetch. Never rely on memory for factual claims.
             ```
             """)
         
@@ -190,43 +214,28 @@ def create_support_docs():
         
         with gr.Accordion("🚀 Deployment Process", open=False):
             gr.Markdown("""
-            ### Step-by-Step Deployment
-            
-            **1. Generate Package**
-            - Click "Generate Deployment Package" in the Configuration tab
-            - Download the zip file when ready
-            - Contains: app.py, requirements.txt, README.md, config.json
-            
-            **2. Create HuggingFace Space**
-            - Go to [huggingface.co/spaces](https://huggingface.co/spaces)
-            - Click "Create new Space"
-            - Choose a name and set to Public or Private
-            - **Important**: Select "Gradio" as the SDK
-            - Click "Create Space"
-            
-            **3. Upload Files**
-            - In your new Space, click the "Files" tab
-            - Upload `app.py` and `requirements.txt` from your zip
-            - Wait for the "Building" status to complete
-            
-            **4. Add API Key**
-            - Go to Settings (gear icon) → "Variables and secrets"
-            - Click "New secret"
-            - Name: Your API key variable name (usually `OPENROUTER_API_KEY`)
-            - Value: Your OpenRouter API key (get from openrouter.ai/keys)
-            - Click "Add"
-            
-            **5. Configure Access (Optional)**
-            - If you set an access code, add another secret:
-            - Name: `SPACE_ACCESS_CODE`
-            - Value: Your chosen access code
-            - Students will need this code to use the assistant
-            
-            **6. Test and Share**
-            - Go back to "App" tab
-            - Your Space should be running!
-            - Test with example prompts
-            - Share the Space URL with students
+            ### Quick Deployment Guide
+            
+            **1. Generate & Upload**
+            - Click "Generate Deployment Package" → download zip
+            - Create new Space at [huggingface.co/spaces](https://huggingface.co/spaces) (select **Gradio** SDK)
+            - Upload `app.py` and `requirements.txt` from zip to Files tab
+            
+            **2. Add Your OpenRouter API Key**
+            Since you already have an OpenRouter API key, add it as a secret:
+            - Go to Settings → Variables and secrets → New secret
+            - Use the interface shown below to add your key:
+            
+            ![HuggingFace Secret Configuration](./secret.png)
+            
+            **3. Optional: Add Access Code**
+            If you configured student access protection:
+            - Add another secret: Name = `SPACE_ACCESS_CODE`, Value = your chosen code
+            
+            **4. Deploy & Share**
+            - Wait for build completion → test in App tab → share URL with students
+            
+            **That's it!** Your Space will be live and ready for use.
             """)
         
         with gr.Accordion("🔧 Troubleshooting", open=False):