Clean up readme, and default config
This commit is contained in:
@@ -1,4 +1,4 @@
|
||||
"""W3Schools-Style Language Reference Handbook service for built-in functions, methods, primitive types, and topics."""
|
||||
"""Language Reference Handbook service for built-in functions, methods, primitive types, and topics."""
|
||||
import httpx
|
||||
from typing import Dict, List, Any
|
||||
from src.core.config import config
|
||||
@@ -197,7 +197,7 @@ HANDBOOK_CATALOG: Dict[str, Dict[str, List[Dict[str, str]]]] = {
|
||||
|
||||
|
||||
class HandbookService:
|
||||
"""W3Schools-Style Language Reference Handbook service."""
|
||||
"""Language Reference Handbook service."""
|
||||
|
||||
def get_catalog(self, language: str) -> Dict[str, List[Dict[str, str]]]:
|
||||
canonical = registry.canonical_name(language)
|
||||
@@ -210,7 +210,7 @@ class HandbookService:
|
||||
lang_name = config_info.get("name", language) if config_info else language
|
||||
|
||||
prompt = (
|
||||
f"Generate a W3Schools-Style Reference Card for '{topic_title}' in {lang_name}.\n"
|
||||
f"Generate a Reference Card for '{topic_title}' in {lang_name}.\n"
|
||||
f"Structure your response strictly into these four Markdown sections:\n"
|
||||
f"1. **Syntax / Signature:** Clear representation of how to invoke or write it.\n"
|
||||
f"2. **Description & Parameters:** Brief summary of parameter types and return value.\n"
|
||||
@@ -219,7 +219,7 @@ class HandbookService:
|
||||
)
|
||||
|
||||
sys_prompt = (
|
||||
"You are an expert W3Schools-Style Documentation Assistant for TactiTerm.\n"
|
||||
"You are an expert Documentation Assistant for TactiTerm.\n"
|
||||
"Provide clean, educational reference cards. Ensure the code example is realistic, complete, and copy-pasteable."
|
||||
)
|
||||
|
||||
@@ -259,7 +259,7 @@ class HandbookService:
|
||||
except Exception as e:
|
||||
return {
|
||||
"status": "error",
|
||||
"message": f"Failed to generate W3Schools reference card via LLM: {e}",
|
||||
"message": f"Failed to generate reference card via LLM: {e}",
|
||||
}
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user