From bfe8133ea3f2108984d1481e63220e716c21f3af Mon Sep 17 00:00:00 2001 From: pomelo-nwu Date: Fri, 5 Dec 2025 10:51:57 +0800 Subject: [PATCH] feat: refactor docs --- docs/_meta.ts | 20 +++++++------ docs/developers/_meta.ts | 23 +++++++++++++++ .../{development => }/architecture.md | 0 docs/developers/cli/_meta.ts | 5 ---- docs/developers/contributing.md | 0 docs/developers/development/_meta.ts | 2 -- docs/developers/roadmap.md | 1 + docs/index.md | 0 docs/users/_meta.ts | 28 +++++++++++++++++++ docs/users/common-workflow.md | 0 docs/users/configuration/_meta.ts | 7 +++++ docs/users/configuration/memory.md | 0 .../configuration}/qwen-ignore.md | 0 docs/users/configuration/settings.md | 0 .../cli => users/configuration}/themes.md | 0 .../configuration}/trusted-folders.md | 0 docs/users/features/_meta.ts | 13 +++++++-- docs/users/features/approval-mode.md | 0 docs/users/features/mcp.md | 0 docs/users/features/sub-commands.md | 0 docs/users/integration-github-action.md | 0 docs/users/integration-vscode.md | 0 docs/users/integration-zed.md | 0 docs/users/overview.md | 0 docs/users/quick-start.md | 0 docs/users/reference/_meta.ts | 3 ++ .../reference}/keyboard-shortcuts.md | 0 .../cli => users/support}/Uninstall.md | 0 docs/users/support/_meta.ts | 2 ++ 29 files changed, 86 insertions(+), 18 deletions(-) create mode 100644 docs/developers/_meta.ts rename docs/developers/{development => }/architecture.md (100%) create mode 100644 docs/developers/contributing.md create mode 100644 docs/developers/roadmap.md create mode 100644 docs/index.md create mode 100644 docs/users/_meta.ts create mode 100644 docs/users/common-workflow.md create mode 100644 docs/users/configuration/_meta.ts create mode 100644 docs/users/configuration/memory.md rename docs/{developers/cli => users/configuration}/qwen-ignore.md (100%) create mode 100644 docs/users/configuration/settings.md rename docs/{developers/cli => users/configuration}/themes.md (100%) rename docs/{developers/cli => users/configuration}/trusted-folders.md (100%) create mode 100644 docs/users/features/approval-mode.md create mode 100644 docs/users/features/mcp.md create mode 100644 docs/users/features/sub-commands.md create mode 100644 docs/users/integration-github-action.md create mode 100644 docs/users/integration-vscode.md create mode 100644 docs/users/integration-zed.md create mode 100644 docs/users/overview.md create mode 100644 docs/users/quick-start.md create mode 100644 docs/users/reference/_meta.ts rename docs/{developers/cli => users/reference}/keyboard-shortcuts.md (100%) rename docs/{developers/cli => users/support}/Uninstall.md (100%) diff --git a/docs/_meta.ts b/docs/_meta.ts index 4939cb31..10f50a10 100644 --- a/docs/_meta.ts +++ b/docs/_meta.ts @@ -1,10 +1,14 @@ export default { - index: 'Welcome to Qwen Code', - cli: 'CLI', - core: 'Core', - tools: 'Tools', - features: 'Features', - 'ide-integration': 'IDE Integration', - development: 'Development', - support: 'Support', + index: { + type: 'page', + display: 'hidden', + }, + users: { + type: 'page', + title: 'User Guide', + }, + developers: { + type: 'page', + title: 'Developer Guide', + }, }; diff --git a/docs/developers/_meta.ts b/docs/developers/_meta.ts new file mode 100644 index 00000000..b73a4b9e --- /dev/null +++ b/docs/developers/_meta.ts @@ -0,0 +1,23 @@ +export default { + 'Contribute to Qwen Code': { + title: 'Contribute to Qwen Code', + type: 'separator', + }, + architecture: 'Architecture', + contributing: 'Contributing Guide', + roadmap: 'Roadmap', + 'Qwen Code SDK': { + title: 'Qwen Code SDK', + type: 'separator', + }, + 'Dive Into Qwen Code': { + title: 'Dive Into Qwen Code', + type: 'separator', + }, + cli: { + display: 'hidden', + }, + core: 'Core', + tools: 'Tools', + // development: 'Development', +}; diff --git a/docs/developers/development/architecture.md b/docs/developers/architecture.md similarity index 100% rename from docs/developers/development/architecture.md rename to docs/developers/architecture.md diff --git a/docs/developers/cli/_meta.ts b/docs/developers/cli/_meta.ts index 1557b595..2f80cc41 100644 --- a/docs/developers/cli/_meta.ts +++ b/docs/developers/cli/_meta.ts @@ -5,12 +5,7 @@ export default { commands: 'Commands', configuration: 'Configuration', 'configuration-v1': 'Configuration (v1)', - themes: 'Themes', tutorials: 'Tutorials', - 'keyboard-shortcuts': 'Keyboard Shortcuts', - 'trusted-folders': 'Trusted Folders', - 'qwen-ignore': 'Ignoring Files', - Uninstall: 'Uninstall', }; /** diff --git a/docs/developers/contributing.md b/docs/developers/contributing.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/developers/development/_meta.ts b/docs/developers/development/_meta.ts index 6428e766..c6d99614 100644 --- a/docs/developers/development/_meta.ts +++ b/docs/developers/development/_meta.ts @@ -1,7 +1,5 @@ export default { - architecture: 'Architecture', npm: 'NPM', - deployment: 'Deployment', telemetry: 'Telemetry', 'integration-tests': 'Integration Tests', 'issue-and-pr-automation': 'Issue and PR Automation', diff --git a/docs/developers/roadmap.md b/docs/developers/roadmap.md new file mode 100644 index 00000000..4213424a --- /dev/null +++ b/docs/developers/roadmap.md @@ -0,0 +1 @@ +# Qwen Code RoadMap diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/users/_meta.ts b/docs/users/_meta.ts new file mode 100644 index 00000000..d932d41c --- /dev/null +++ b/docs/users/_meta.ts @@ -0,0 +1,28 @@ +export default { + 'Getting started': { + type: 'separator', + title: 'Getting started', // Title is optional + }, + overview: 'Overview', + 'quick-start': 'QuickStart', + 'common-workflow': 'Command Workflows', + 'Outside of the terminal': { + type: 'separator', + title: 'Outside of the terminal', // Title is optional + }, + 'integration-github-action': 'Github Action', + 'integration-vscode': 'VSCode Extension', + 'integration-zed': 'Zed IDE', + 'Code with Qwen Code': { + type: 'separator', + title: 'Code with Qwen Code', // Title is optional + }, + features: 'Features', + configuration: 'Configuration', + reference: 'Reference', + support: 'Support', + // need refine + 'ide-integration': { + display: 'hidden', + }, +}; diff --git a/docs/users/common-workflow.md b/docs/users/common-workflow.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/users/configuration/_meta.ts b/docs/users/configuration/_meta.ts new file mode 100644 index 00000000..f8f17c07 --- /dev/null +++ b/docs/users/configuration/_meta.ts @@ -0,0 +1,7 @@ +export default { + settings: 'Settings File', + memory: 'Memory Management', + 'trusted-folders': 'Trusted Folders', + 'qwen-ignore': 'Ignoring Files', + themes: 'Themes', +}; diff --git a/docs/users/configuration/memory.md b/docs/users/configuration/memory.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/developers/cli/qwen-ignore.md b/docs/users/configuration/qwen-ignore.md similarity index 100% rename from docs/developers/cli/qwen-ignore.md rename to docs/users/configuration/qwen-ignore.md diff --git a/docs/users/configuration/settings.md b/docs/users/configuration/settings.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/developers/cli/themes.md b/docs/users/configuration/themes.md similarity index 100% rename from docs/developers/cli/themes.md rename to docs/users/configuration/themes.md diff --git a/docs/developers/cli/trusted-folders.md b/docs/users/configuration/trusted-folders.md similarity index 100% rename from docs/developers/cli/trusted-folders.md rename to docs/users/configuration/trusted-folders.md diff --git a/docs/users/features/_meta.ts b/docs/users/features/_meta.ts index 7ad3361c..39736dfc 100644 --- a/docs/users/features/_meta.ts +++ b/docs/users/features/_meta.ts @@ -1,8 +1,15 @@ export default { subagents: 'Subagents', - checkpointing: 'Checkpointing', - sandbox: 'Sandbox Support', + 'sub-commands': 'Sub Commands', + checkpointing: { + display: 'hidden', + }, headless: 'Headless Mode', - 'welcome-back': 'Welcome Back', + 'welcome-back': { + display: 'hidden', + }, + 'approval-mode': 'Approval Mode', 'token-caching': 'Token Caching', + mcp: 'MCP', + sandbox: 'Sandboxing', }; diff --git a/docs/users/features/approval-mode.md b/docs/users/features/approval-mode.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/users/features/mcp.md b/docs/users/features/mcp.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/users/features/sub-commands.md b/docs/users/features/sub-commands.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/users/integration-github-action.md b/docs/users/integration-github-action.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/users/integration-vscode.md b/docs/users/integration-vscode.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/users/integration-zed.md b/docs/users/integration-zed.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/users/overview.md b/docs/users/overview.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/users/quick-start.md b/docs/users/quick-start.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/users/reference/_meta.ts b/docs/users/reference/_meta.ts new file mode 100644 index 00000000..a4c232e8 --- /dev/null +++ b/docs/users/reference/_meta.ts @@ -0,0 +1,3 @@ +export default { + 'keyboard-shortcuts': 'Keyboard Shortcuts', +}; diff --git a/docs/developers/cli/keyboard-shortcuts.md b/docs/users/reference/keyboard-shortcuts.md similarity index 100% rename from docs/developers/cli/keyboard-shortcuts.md rename to docs/users/reference/keyboard-shortcuts.md diff --git a/docs/developers/cli/Uninstall.md b/docs/users/support/Uninstall.md similarity index 100% rename from docs/developers/cli/Uninstall.md rename to docs/users/support/Uninstall.md diff --git a/docs/users/support/_meta.ts b/docs/users/support/_meta.ts index 9140d4fe..1407565a 100644 --- a/docs/users/support/_meta.ts +++ b/docs/users/support/_meta.ts @@ -1,4 +1,6 @@ export default { troubleshooting: 'Troubleshooting', 'tos-privacy': 'Terms of Service', + + Uninstall: 'Uninstall', };