diff --git a/docs/_meta.ts b/docs/_meta.ts new file mode 100644 index 00000000..07afc2ac --- /dev/null +++ b/docs/_meta.ts @@ -0,0 +1,10 @@ +export default { + overview: 'Overview', + cli: 'CLI', + core: 'Core', + tools: 'Tools', + features: 'Features', + 'ide-integration': 'IDE Integration', + development: 'Development', + support: 'Support', +}; diff --git a/docs/Uninstall.md b/docs/cli/Uninstall.md similarity index 100% rename from docs/Uninstall.md rename to docs/cli/Uninstall.md diff --git a/docs/cli/_meta.ts b/docs/cli/_meta.ts new file mode 100644 index 00000000..17263870 --- /dev/null +++ b/docs/cli/_meta.ts @@ -0,0 +1,35 @@ +export default { + index: 'Introduction', + authentication: 'Authentication', + 'openai-auth': 'OpenAI Authentication', + commands: 'Commands', + configuration: 'Configuration', + 'configuration-v1': 'Configuration (v1)', + themes: 'Themes', + tutorials: 'Tutorials', + 'keyboard-shortcuts': 'Keyboard Shortcuts', + 'trusted-folders': 'Trusted Folders', + Uninstall: 'Uninstall', + 'qwen-ignore': 'Ignoring Files', +}; + +/** + * + * { "label": "Introduction", "slug": "docs/cli" }, + { "label": "Authentication", "slug": "docs/cli/authentication" }, + { "label": "Commands", "slug": "docs/cli/commands" }, + { "label": "Configuration", "slug": "docs/cli/configuration" }, + { "label": "Checkpointing", "slug": "docs/checkpointing" }, + { "label": "Extensions", "slug": "docs/extension" }, + { "label": "Headless Mode", "slug": "docs/headless" }, + { "label": "IDE Integration", "slug": "docs/ide-integration" }, + { + "label": "IDE Companion Spec", + "slug": "docs/ide-companion-spec" + }, + { "label": "Telemetry", "slug": "docs/telemetry" }, + { "label": "Themes", "slug": "docs/cli/themes" }, + { "label": "Token Caching", "slug": "docs/cli/token-caching" }, + { "label": "Trusted Folders", "slug": "docs/trusted-folders" }, + { "label": "Tutorials", "slug": "docs/cli/tutorials" } + */ diff --git a/docs/cli/index.md b/docs/cli/index.md index 6dd24b2a..0a7dd20c 100644 --- a/docs/cli/index.md +++ b/docs/cli/index.md @@ -7,11 +7,8 @@ Within Qwen Code, `packages/cli` is the frontend for users to send and receive p - **[Authentication](./authentication.md):** A guide to setting up authentication with Qwen OAuth and OpenAI-compatible providers. - **[Commands](./commands.md):** A reference for Qwen Code CLI commands (e.g., `/help`, `/tools`, `/theme`). - **[Configuration](./configuration.md):** A guide to tailoring Qwen Code CLI behavior using configuration files. -- **[Headless Mode](../headless.md):** A comprehensive guide to using Qwen Code programmatically for scripting and automation. -- **[Token Caching](./token-caching.md):** Optimize API costs through token caching. - **[Themes](./themes.md)**: A guide to customizing the CLI's appearance with different themes. - **[Tutorials](tutorials.md)**: A tutorial showing how to use Qwen Code to automate a development task. -- **[Welcome Back](./welcome-back.md)**: Learn about the Welcome Back feature that helps you resume work seamlessly across sessions. ## Non-interactive mode diff --git a/docs/keyboard-shortcuts.md b/docs/cli/keyboard-shortcuts.md similarity index 100% rename from docs/keyboard-shortcuts.md rename to docs/cli/keyboard-shortcuts.md diff --git a/docs/qwen-ignore.md b/docs/cli/qwen-ignore.md similarity index 100% rename from docs/qwen-ignore.md rename to docs/cli/qwen-ignore.md diff --git a/docs/trusted-folders.md b/docs/cli/trusted-folders.md similarity index 100% rename from docs/trusted-folders.md rename to docs/cli/trusted-folders.md diff --git a/docs/development/_meta.ts b/docs/development/_meta.ts new file mode 100644 index 00000000..e984be78 --- /dev/null +++ b/docs/development/_meta.ts @@ -0,0 +1,7 @@ +export default { + npm: 'NPM', + releases: 'Releases', + telemetry: 'Telemetry', + 'integration-tests': 'Integration Tests', + 'issue-and-pr-automation': 'Issue and PR Automation', +}; diff --git a/docs/deployment.md b/docs/development/deployment.md similarity index 100% rename from docs/deployment.md rename to docs/development/deployment.md diff --git a/docs/integration-tests.md b/docs/development/integration-tests.md similarity index 100% rename from docs/integration-tests.md rename to docs/development/integration-tests.md diff --git a/docs/issue-and-pr-automation.md b/docs/development/issue-and-pr-automation.md similarity index 100% rename from docs/issue-and-pr-automation.md rename to docs/development/issue-and-pr-automation.md diff --git a/docs/npm.md b/docs/development/npm.md similarity index 100% rename from docs/npm.md rename to docs/development/npm.md diff --git a/docs/telemetry.md b/docs/development/telemetry.md similarity index 100% rename from docs/telemetry.md rename to docs/development/telemetry.md diff --git a/docs/extension-releasing.md b/docs/extensions/extension-releasing.md similarity index 100% rename from docs/extension-releasing.md rename to docs/extensions/extension-releasing.md diff --git a/docs/extension.md b/docs/extensions/extension.md similarity index 100% rename from docs/extension.md rename to docs/extensions/extension.md diff --git a/docs/getting-started-extensions.md b/docs/extensions/getting-started-extensions.md similarity index 100% rename from docs/getting-started-extensions.md rename to docs/extensions/getting-started-extensions.md diff --git a/docs/features/_meta.ts b/docs/features/_meta.ts new file mode 100644 index 00000000..92a594b1 --- /dev/null +++ b/docs/features/_meta.ts @@ -0,0 +1,8 @@ +export default { + subagent: 'Subagent', + checkpointing: 'Checkpointing', + sandbox: 'Sandbox Support', + 'headless-mode': 'Headless Mode', + 'welcome-back': 'Welcome Back', + 'token-caching': 'Token Caching', +}; diff --git a/docs/checkpointing.md b/docs/features/checkpointing.md similarity index 100% rename from docs/checkpointing.md rename to docs/features/checkpointing.md diff --git a/docs/headless.md b/docs/features/headless.md similarity index 100% rename from docs/headless.md rename to docs/features/headless.md diff --git a/docs/sandbox.md b/docs/features/sandbox.md similarity index 100% rename from docs/sandbox.md rename to docs/features/sandbox.md diff --git a/docs/subagents.md b/docs/features/subagents.md similarity index 100% rename from docs/subagents.md rename to docs/features/subagents.md diff --git a/docs/cli/token-caching.md b/docs/features/token-caching.md similarity index 100% rename from docs/cli/token-caching.md rename to docs/features/token-caching.md diff --git a/docs/cli/welcome-back.md b/docs/features/welcome-back.md similarity index 100% rename from docs/cli/welcome-back.md rename to docs/features/welcome-back.md diff --git a/docs/ide-integration/_meta.ts b/docs/ide-integration/_meta.ts new file mode 100644 index 00000000..61c0cf10 --- /dev/null +++ b/docs/ide-integration/_meta.ts @@ -0,0 +1,4 @@ +export default { + index: 'Introduction', + 'ide-companion-spec': 'IDE Companion Spec', +}; diff --git a/docs/ide-companion-spec.md b/docs/ide-integration/ide-companion-spec.md similarity index 100% rename from docs/ide-companion-spec.md rename to docs/ide-integration/ide-companion-spec.md diff --git a/docs/ide-integration.md b/docs/ide-integration/ide-integration.md similarity index 100% rename from docs/ide-integration.md rename to docs/ide-integration/ide-integration.md diff --git a/docs/overview/_meta.ts b/docs/overview/_meta.ts new file mode 100644 index 00000000..b5508759 --- /dev/null +++ b/docs/overview/_meta.ts @@ -0,0 +1,4 @@ +export default { + index: 'Introduction', + architecture: 'Architecture Overview', +}; diff --git a/docs/architecture.md b/docs/overview/architecture.md similarity index 100% rename from docs/architecture.md rename to docs/overview/architecture.md diff --git a/docs/index.md b/docs/overview/index.md similarity index 100% rename from docs/index.md rename to docs/overview/index.md diff --git a/docs/support/_meta.ts b/docs/support/_meta.ts new file mode 100644 index 00000000..62085ee5 --- /dev/null +++ b/docs/support/_meta.ts @@ -0,0 +1,5 @@ +export default { + faq: 'FAQ', + troubleshooting: 'Troubleshooting', + 'tos-privacy': 'Terms of Service', +}; diff --git a/docs/tos-privacy.md b/docs/support/tos-privacy.md similarity index 100% rename from docs/tos-privacy.md rename to docs/support/tos-privacy.md diff --git a/docs/troubleshooting.md b/docs/support/troubleshooting.md similarity index 100% rename from docs/troubleshooting.md rename to docs/support/troubleshooting.md diff --git a/docs/tools/_meta.ts b/docs/tools/_meta.ts new file mode 100644 index 00000000..9d0ee9ca --- /dev/null +++ b/docs/tools/_meta.ts @@ -0,0 +1,11 @@ +export default { + overview: 'Overview', + 'file-system': 'File System', + 'multi-file': 'Multi-File Read', + shell: 'Shell', + 'todo-write': 'Todo Write', + 'web-fetch': 'Web Fetch', + 'web-search': 'Web Search', + memory: 'Memory', + 'mcp-server': 'MCP Servers', +};