Add documents site (#1767)

* feat: add docs site - Implemented dynamic routing for MDX documentation pages with language support. - Created layout components for documentation with a header and footer. - Added metadata for various documentation sections in English and Chinese. - Developed initial content for the DeerFlow App and Harness documentation. - Introduced i18n hooks and translations for English and Chinese languages. - Enhanced header component to include navigation links for documentation and blog. - Established a structure for tutorials and reference materials. - Created a new translations file to manage locale-specific strings. * feat: enhance documentation structure and content for application and harness sections * feat: update .gitignore to include .playwright-mcp and remove obsolete Playwright YAML file * fix(docs): correct punctuation and formatting in documentation files * feat(docs): remove outdated index.mdx file from documentation * fix(docs): update documentation links and improve Chinese description in index.mdx * fix(docs): update title in Chinese for meta information in _meta.ts
2026-04-03 07:25:40 +08:00
parent ef711a48b3
commit c1366cf559
55 changed files with 2245 additions and 29 deletions
@@ -0,0 +1,36 @@
+import type { MetaRecord } from "nextra";
+
+const meta: MetaRecord = {
+  index: {
+    title: "Install",
+  },
+  "quick-start": {
+    title: "Quick Start",
+  },
+  "design-principles": {
+    title: "Design Principles",
+  },
+  configuration: {
+    title: "Configuration",
+  },
+  memory: {
+    title: "Memory",
+  },
+  tools: {
+    title: "Tools",
+  },
+  skills: {
+    title: "Skills",
+  },
+  sandbox: {
+    title: "Sandbox",
+  },
+  customization: {
+    title: "Customization",
+  },
+  "integration-guide": {
+    title: "Integration Guide",
+  },
+};
+
+export default meta;
@@ -0,0 +1,3 @@
+# Configuration
+
+TBD
@@ -0,0 +1,3 @@
+# Customization
+
+TBD
@@ -0,0 +1,3 @@
+# Design Principles
+
+TBD
@@ -0,0 +1,50 @@
+import { Callout, Cards } from "nextra/components";
+
+# Install DeerFlow Harness
+
+<Callout type="info" emoji="📦">
+  The DeerFlow Harness Python package will be published as <code>deerflow</code>
+  . It is not released yet, so installation is currently{" "}
+  <strong>Coming Soon</strong>.
+</Callout>
+
+The DeerFlow Harness is the Python SDK and runtime foundation for building your own Super Agent systems.
+
+If you want to compose agents with skills, memory, tools, sandboxes, and subagents inside your own product or workflow, this is the part of DeerFlow you will build on.
+
+## Package name
+
+The package name will be:
+
+```bash
+pip install deerflow
+```
+
+That package is not publicly available yet, but this is the installation path the documentation will use once it is released.
+
+## Current status
+
+The DeerFlow Harness package is **coming soon**.
+
+At the moment, this section exists to establish the SDK entry point and package identity, while the public distribution flow is being finalized.
+
+## What the Harness will give you
+
+The Harness is designed for developers who want to build their own agent system on top of DeerFlow's runtime model.
+
+It will provide the foundation for:
+
+- building long-horizon agents,
+- composing runtime capabilities such as memory, tools, skills, and subagents,
+- running agents with sandboxed execution,
+- customizing agent behavior through configuration and code, and
+- integrating DeerFlow into your own application architecture.
+
+## What to do next
+
+Until the package is released, the best way to understand the DeerFlow Harness is to read the conceptual and implementation docs in this section.
+
+<Cards num={2}>
+  <Cards.Card title="Quick Start" href="/docs/harness/quick-start" />
+  <Cards.Card title="Configuration" href="/docs/harness/configuration" />
+</Cards>
@@ -0,0 +1,3 @@
+# Integration Guide
+
+TBD
@@ -0,0 +1,3 @@
+# Memory
+
+TBD
@@ -0,0 +1,3 @@
+# Quick Start
+
+TBD
@@ -0,0 +1,3 @@
+# Sandbox
+
+TBD
@@ -0,0 +1,3 @@
+# Skills
+
+TBD
@@ -0,0 +1,3 @@
+# Tools
+
+TBD