feat: Make related docs SDK-specific

- Rust SDK pages link only to /docs/rust/ pages
- TypeScript SDK pages link only to /docs/typescript/ pages
- Python SDK pages link to concepts/guides/features (as main SDK)
- Add package parameter to render_related_section

Author: MervinPraison

praisonai_tools/docs_generator/generate_rust_docs.py

@@ -78,68 +78,69 @@ def sanitize_description(text: str, max_len: int = 150) -> str:
 # Abbreviations to preserve in titles
 ABBREVIATIONS = {"llm", "api", "cli", "id", "url", "http", "ai", "io"}
 
-# Related documentation mapping (keyword -> list of (title, path, icon))
+# Related documentation mapping - Rust SDK only links to Rust docs
 RELATED_DOCS = {
     "agent": [
+        ("Rust Overview", "/docs/rust/overview", "book-open"),
         ("Rust Quickstart", "/docs/rust/quickstart", "rocket"),
         ("Rust Agent Guide", "/docs/rust/agent", "robot"),
-        ("Agents Concept", "/docs/concepts/agents", "brain"),
+        ("Rust Installation", "/docs/rust/installation", "download"),
     ],
     "builder": [
-        ("Rust Quickstart", "/docs/rust/quickstart", "rocket"),
         ("Rust Agent Guide", "/docs/rust/agent", "robot"),
+        ("Rust Quickstart", "/docs/rust/quickstart", "rocket"),
     ],
     "tool": [
         ("Rust Tools Guide", "/docs/rust/tools", "wrench"),
-        ("Tools Concept", "/docs/concepts/tools", "gear"),
+        ("Rust Agent Guide", "/docs/rust/agent", "robot"),
     ],
     "workflow": [
         ("Rust Agent Flow", "/docs/rust/agent-flow", "diagram-project"),
         ("Rust Agent Team", "/docs/rust/agent-team", "users"),
-        ("AgentFlow Concept", "/docs/concepts/agentflow", "route"),
     ],
     "memory": [
         ("Rust Memory Guide", "/docs/rust/memory", "brain"),
-        ("Memory Concept", "/docs/concepts/memory", "database"),
+        ("Rust Agent Guide", "/docs/rust/agent", "robot"),
     ],
     "llm": [
-        ("Models Overview", "/docs/models", "microchip"),
-        ("Model Failover", "/docs/features/model-failover", "shield"),
+        ("Rust Overview", "/docs/rust/overview", "book-open"),
+        ("Rust Agent Guide", "/docs/rust/agent", "robot"),
     ],
     "config": [
-        ("Configuration Overview", "/docs/configuration/index", "gear"),
+        ("Rust Installation", "/docs/rust/installation", "gear"),
+        ("Rust Overview", "/docs/rust/overview", "book-open"),
     ],
     "error": [
-        ("Guardrails Feature", "/docs/features/guardrails", "shield"),
+        ("Rust Overview", "/docs/rust/overview", "book-open"),
     ],
     "derive": [
         ("Rust Tools Guide", "/docs/rust/tools", "wrench"),
     ],
     "cli": [
         ("Rust CLI Guide", "/docs/rust/cli", "terminal"),
-        ("CLI Feature", "/docs/features/cli", "terminal"),
+        ("Rust Quickstart", "/docs/rust/quickstart", "rocket"),
     ],
     "chat": [
-        ("Chat Feature", "/docs/features/chat", "comments"),
         ("Rust CLI Guide", "/docs/rust/cli", "terminal"),
     ],
     "prompt": [
         ("Rust CLI Guide", "/docs/rust/cli", "terminal"),
     ],
     "run": [
         ("Rust CLI Guide", "/docs/rust/cli", "terminal"),
-        ("Workflows Feature", "/docs/features/workflows", "diagram-project"),
+        ("Rust Agent Flow", "/docs/rust/agent-flow", "diagram-project"),
     ],
     "task": [
-        ("Tasks Concept", "/docs/concepts/tasks", "list-check"),
+        ("Rust Agent Team", "/docs/rust/agent-team", "users"),
+        ("Rust Agent Flow", "/docs/rust/agent-flow", "diagram-project"),
     ],
     "team": [
         ("Rust Agent Team", "/docs/rust/agent-team", "users"),
-        ("AgentTeam Concept", "/docs/concepts/agentteam", "users"),
+        ("Rust Agent Flow", "/docs/rust/agent-flow", "diagram-project"),
     ],
     "flow": [
         ("Rust Agent Flow", "/docs/rust/agent-flow", "diagram-project"),
-        ("AgentFlow Concept", "/docs/concepts/agentflow", "route"),
+        ("Rust Agent Team", "/docs/rust/agent-team", "users"),
     ],
 }
 

praisonai_tools/docs_generator/generator.py

@@ -501,13 +501,53 @@ def friendly_title(name: str, page_type: str = "class") -> str:
     ],
 }
 
+# TypeScript SDK links to TypeScript-specific docs
+TYPESCRIPT_RELATED_DOCS = {
+    "agent": [
+        ("TypeScript Overview", "/docs/typescript/overview", "book-open"),
+        ("TypeScript Quickstart", "/docs/typescript/quickstart", "rocket"),
+        ("TypeScript Agent", "/docs/typescript/agent", "robot"),
+    ],
+    "tool": [
+        ("TypeScript Tools", "/docs/typescript/tools", "wrench"),
+        ("TypeScript Agent", "/docs/typescript/agent", "robot"),
+    ],
+    "config": [
+        ("TypeScript Installation", "/docs/typescript/installation", "download"),
+        ("TypeScript Overview", "/docs/typescript/overview", "book-open"),
+    ],
+    "memory": [
+        ("TypeScript Memory", "/docs/typescript/memory", "brain"),
+    ],
+    "workflow": [
+        ("TypeScript AgentFlow", "/docs/typescript/agentflow", "diagram-project"),
+        ("TypeScript AgentTeam", "/docs/typescript/agentteam", "users"),
+    ],
+    "team": [
+        ("TypeScript AgentTeam", "/docs/typescript/agentteam", "users"),
+    ],
+    "flow": [
+        ("TypeScript AgentFlow", "/docs/typescript/agentflow", "diagram-project"),
+    ],
+    "task": [
+        ("TypeScript AgentTeam", "/docs/typescript/agentteam", "users"),
+    ],
+    "mcp": [
+        ("TypeScript MCP", "/docs/typescript/mcp", "plug"),
+    ],
+    "llm": [
+        ("TypeScript Overview", "/docs/typescript/overview", "book-open"),
+    ],
+}
 
-def get_related_docs(name: str, max_items: int = 5) -> list:
+
+def get_related_docs(name: str, max_items: int = 5, package: str = "python") -> list:
     """Find related documentation based on keywords in the name.
     
     Args:
         name: Class, function, or module name to find related docs for
         max_items: Maximum number of related docs to return
+        package: Package name to determine which mapping to use
         
     Returns:
         List of (title, path, icon) tuples, most relevant first
@@ -516,8 +556,14 @@ def get_related_docs(name: str, max_items: int = 5) -> list:
     related = []
     seen_paths = set()
 
+    # Select the appropriate mapping based on package
+    if package == "typescript":
+        docs_map = TYPESCRIPT_RELATED_DOCS
+    else:
+        docs_map = RELATED_DOCS  # Python packages use the main mapping
+    
     # Check each keyword against the name
-    for keyword, docs in RELATED_DOCS.items():
+    for keyword, docs in docs_map.items():
         if keyword in name_lower:
             for doc in docs:
                 if doc[1] not in seen_paths:
@@ -527,17 +573,18 @@ def get_related_docs(name: str, max_items: int = 5) -> list:
     return related[:max_items]
 
 
-def render_related_section(name: str, max_items: int = 5) -> str:
+def render_related_section(name: str, max_items: int = 5, package: str = "python") -> str:
     """Render a CardGroup section with related documentation links.
     
     Args:
         name: Class, function, or module name
         max_items: Maximum related items to show
+        package: Package name to determine which links to use
         
     Returns:
         MDX string with CardGroup, or empty string if no related docs
     """
-    related = get_related_docs(name, max_items)
+    related = get_related_docs(name, max_items, package)
     if not related:
         return ""
 
@@ -1249,7 +1296,7 @@ def _render_module(self, info: ModuleInfo) -> str:
                 lines.append(f"| `{name}` | `{escape_for_table(truncated_val, is_type=False)}` |")
             lines.append("")
         # Add related documentation section
-        related_section = render_related_section(info.short_name, max_items=5)
+        related_section = render_related_section(info.short_name, max_items=5, package=self.package_name)
         if related_section:
             lines.append(related_section)
 
@@ -1333,7 +1380,7 @@ def _render_module_granular(self, info: ModuleInfo) -> str:
                 lines.append(f"| `{name}` | `{escape_for_table(truncated_val, is_type=False)}` |")
             lines.append("")
         # Add related documentation section
-        related_section = render_related_section(info.short_name, max_items=5)
+        related_section = render_related_section(info.short_name, max_items=5, package=self.package_name)
         if related_section:
             lines.append(related_section)
 
@@ -1467,7 +1514,7 @@ def _render_class_page(self, cls: ClassInfo, module_info: ModuleInfo) -> str:
                 lines.append(f"```{lang}\n{cls.examples[0]}\n```\n")
 
         # Add related documentation section
-        related_section = render_related_section(cls.name, max_items=5)
+        related_section = render_related_section(cls.name, max_items=5, package=self.package_name)
         if related_section:
             lines.append(related_section)
 
@@ -1577,7 +1624,7 @@ def _render_function_page(self, func: FunctionInfo, module_info: ModuleInfo, cls
                 lines.append(f"```python\n{dedented_ex}\n```\n")
 
         # Add related documentation section
-        related_section = render_related_section(func.name, max_items=5)
+        related_section = render_related_section(func.name, max_items=5, package=self.package_name)
         if related_section:
             lines.append(related_section)