From 86442d375825795f49e2f7145873026cbb0fe004 Mon Sep 17 00:00:00 2001 From: Harish Mohan Raj Date: Tue, 28 Jan 2025 22:49:45 +0530 Subject: [PATCH] WIP --- autogen/_website/generate_api_references.py | 8 ++--- website/docs/.gitignore | 1 + website/docs/use-cases/.gitignore | 2 ++ .../reference-agents/captainagent.mdx | 1 + .../reference-agents/communication-agents.mdx | 1 + .../reference-agents/documentagent.mdx | 1 + .../use-cases/reference-agents/index.md | 0 .../reference-agents/reasoningagent.mdx | 1 + .../reference-agents/websurferagent.mdx | 1 + .../use-cases/sample-apps/sample-apps.mdx | 1 + website/mint-json-template.json.jinja | 36 ++++++++++++++++--- website/mint-script.js | 2 +- .../reference-agents/captainagent.md | 1 - .../reference-agents/communication-agents.md | 1 - .../reference-agents/documentagent.md | 1 - .../reference-agents/reasoningagent.md | 1 - .../reference-agents/websurferagent.md | 1 - 17 files changed, 46 insertions(+), 14 deletions(-) create mode 100644 website/docs/use-cases/.gitignore create mode 100644 website/docs/use-cases/reference-agents/captainagent.mdx create mode 100644 website/docs/use-cases/reference-agents/communication-agents.mdx create mode 100644 website/docs/use-cases/reference-agents/documentagent.mdx rename website/{ => docs}/use-cases/reference-agents/index.md (100%) create mode 100644 website/docs/use-cases/reference-agents/reasoningagent.mdx create mode 100644 website/docs/use-cases/reference-agents/websurferagent.mdx create mode 100644 website/docs/use-cases/sample-apps/sample-apps.mdx delete mode 100644 website/use-cases/reference-agents/captainagent.md delete mode 100644 website/use-cases/reference-agents/communication-agents.md delete mode 100644 website/use-cases/reference-agents/documentagent.md delete mode 100644 website/use-cases/reference-agents/reasoningagent.md delete mode 100644 website/use-cases/reference-agents/websurferagent.md diff --git a/autogen/_website/generate_api_references.py b/autogen/_website/generate_api_references.py index bfffe399b3..041a29bd29 100755 --- a/autogen/_website/generate_api_references.py +++ b/autogen/_website/generate_api_references.py @@ -174,7 +174,7 @@ def get_mdx_files(directory: Path) -> list[str]: def add_prefix(path: str, parent_groups: Optional[list[str]] = None) -> str: """Create full path with prefix and parent groups.""" groups = parent_groups or [] - return f"reference/{'/'.join(groups + [path])}" + return f"docs/api-reference/{'/'.join(groups + [path])}" def create_nav_structure(paths: list[str], parent_groups: Optional[list[str]] = None) -> list[Any]: @@ -290,14 +290,14 @@ def _generate_overview(self, classes: list[str], functions: list[str], output_di overview += "\n\n## Classes\n" for symbol in sorted(classes): href = output_dir / symbol - overview += f"""

class {symbol}

""" + overview += f"""

class {symbol}

""" overview += "\n" if functions: overview += "\n\n## Functions\n" for symbol in sorted(functions): href = output_dir / symbol - overview += f"""

{symbol}

""" + overview += f"""

{symbol}

""" overview += "\n" return overview @@ -372,7 +372,7 @@ def main() -> None: "--api-dir", type=Path, help="Directory containing API documentation to process", - default=website_dir / "reference", + default=website_dir / "docs" / "api-reference", ) args = parser.parse_args() diff --git a/website/docs/.gitignore b/website/docs/.gitignore index fc5189323b..5563ebc640 100644 --- a/website/docs/.gitignore +++ b/website/docs/.gitignore @@ -1 +1,2 @@ topics +api-reference diff --git a/website/docs/use-cases/.gitignore b/website/docs/use-cases/.gitignore new file mode 100644 index 0000000000..db27168276 --- /dev/null +++ b/website/docs/use-cases/.gitignore @@ -0,0 +1,2 @@ +community-gallery +notebooks diff --git a/website/docs/use-cases/reference-agents/captainagent.mdx b/website/docs/use-cases/reference-agents/captainagent.mdx new file mode 100644 index 0000000000..1333ed77b7 --- /dev/null +++ b/website/docs/use-cases/reference-agents/captainagent.mdx @@ -0,0 +1 @@ +TODO diff --git a/website/docs/use-cases/reference-agents/communication-agents.mdx b/website/docs/use-cases/reference-agents/communication-agents.mdx new file mode 100644 index 0000000000..1333ed77b7 --- /dev/null +++ b/website/docs/use-cases/reference-agents/communication-agents.mdx @@ -0,0 +1 @@ +TODO diff --git a/website/docs/use-cases/reference-agents/documentagent.mdx b/website/docs/use-cases/reference-agents/documentagent.mdx new file mode 100644 index 0000000000..1333ed77b7 --- /dev/null +++ b/website/docs/use-cases/reference-agents/documentagent.mdx @@ -0,0 +1 @@ +TODO diff --git a/website/use-cases/reference-agents/index.md b/website/docs/use-cases/reference-agents/index.md similarity index 100% rename from website/use-cases/reference-agents/index.md rename to website/docs/use-cases/reference-agents/index.md diff --git a/website/docs/use-cases/reference-agents/reasoningagent.mdx b/website/docs/use-cases/reference-agents/reasoningagent.mdx new file mode 100644 index 0000000000..1333ed77b7 --- /dev/null +++ b/website/docs/use-cases/reference-agents/reasoningagent.mdx @@ -0,0 +1 @@ +TODO diff --git a/website/docs/use-cases/reference-agents/websurferagent.mdx b/website/docs/use-cases/reference-agents/websurferagent.mdx new file mode 100644 index 0000000000..1333ed77b7 --- /dev/null +++ b/website/docs/use-cases/reference-agents/websurferagent.mdx @@ -0,0 +1 @@ +TODO diff --git a/website/docs/use-cases/sample-apps/sample-apps.mdx b/website/docs/use-cases/sample-apps/sample-apps.mdx new file mode 100644 index 0000000000..1333ed77b7 --- /dev/null +++ b/website/docs/use-cases/sample-apps/sample-apps.mdx @@ -0,0 +1 @@ +TODO diff --git a/website/mint-json-template.json.jinja b/website/mint-json-template.json.jinja index d435619905..a4ba6196c3 100644 --- a/website/mint-json-template.json.jinja +++ b/website/mint-json-template.json.jinja @@ -49,11 +49,11 @@ }, { "name": "API References", - "url": "reference" + "url": "docs/api-reference" }, { "name": "Use Cases", - "url": "use-cases" + "url": "docs/use-cases" }, { "name": "Contribute", @@ -66,6 +66,14 @@ { "name": "Ecosystem", "url": "ecosystem" + }, + { + "name": "Blog", + "url": "docs/blog" + }, + { + "name": "Community Talks", + "url": "docs/talks" } ], "anchors": [], @@ -115,8 +123,28 @@ { "group": "Use Cases", "pages": [ - "/use-cases/agent_chat", - "/use-cases/enhanced_inference" + { + "group": "Reference Agents", + "pages": [ + "docs/use-cases/reference-agents/captainagent", + "docs/use-cases/reference-agents/communication-agents", + "docs/use-cases/reference-agents/documentagent", + "docs/use-cases/reference-agents/reasoningagent", + "docs/use-cases/reference-agents/websurferagent" + ] + }, + { + "group": "Notebooks", + "pages": ["docs/use-cases/notebooks/notebooks"] + }, + { + "group": "Sample Apps", + "pages": ["docs/use-cases/sample-apps/sample-apps"] + }, + { + "group": "Community Gallery", + "pages": ["docs/use-cases/community-gallery/community-gallery"] + } ] }, { diff --git a/website/mint-script.js b/website/mint-script.js index e64376e310..73cb24b74c 100644 --- a/website/mint-script.js +++ b/website/mint-script.js @@ -1,7 +1,7 @@ (function () { function updateClass() { document.body.classList.remove("reference-page"); - if (window.location.pathname.includes("/reference/")) { + if (window.location.pathname.includes("/docs/api-reference/")) { document.body.classList.add("reference-page"); } } diff --git a/website/use-cases/reference-agents/captainagent.md b/website/use-cases/reference-agents/captainagent.md deleted file mode 100644 index 564c6790d5..0000000000 --- a/website/use-cases/reference-agents/captainagent.md +++ /dev/null @@ -1 +0,0 @@ -# CaptainAgent diff --git a/website/use-cases/reference-agents/communication-agents.md b/website/use-cases/reference-agents/communication-agents.md deleted file mode 100644 index 2ff9bfd6ea..0000000000 --- a/website/use-cases/reference-agents/communication-agents.md +++ /dev/null @@ -1 +0,0 @@ -# Communication Agents diff --git a/website/use-cases/reference-agents/documentagent.md b/website/use-cases/reference-agents/documentagent.md deleted file mode 100644 index a9d2421ae8..0000000000 --- a/website/use-cases/reference-agents/documentagent.md +++ /dev/null @@ -1 +0,0 @@ -# DocumentAgent diff --git a/website/use-cases/reference-agents/reasoningagent.md b/website/use-cases/reference-agents/reasoningagent.md deleted file mode 100644 index ac7897428c..0000000000 --- a/website/use-cases/reference-agents/reasoningagent.md +++ /dev/null @@ -1 +0,0 @@ -# ReasoningAgent diff --git a/website/use-cases/reference-agents/websurferagent.md b/website/use-cases/reference-agents/websurferagent.md deleted file mode 100644 index e0f7723ca7..0000000000 --- a/website/use-cases/reference-agents/websurferagent.md +++ /dev/null @@ -1 +0,0 @@ -# WebSurferAgent