mirror of
https://github.com/QwenLM/qwen-code.git
synced 2025-12-19 09:33:53 +00:00
docs: Revise documentation structure and update content for clarity
This commit is contained in:
@@ -0,0 +1,24 @@
|
|||||||
|
|
||||||
|
# Qwen Code Documentation
|
||||||
|
|
||||||
|
Welcome to the Qwen Code documentation. Qwen Code is an agentic coding tool that lives in your terminal and helps you turn ideas into code faster than ever before.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## Documentation Sections
|
||||||
|
|
||||||
|
### [User Guide](/users/overview)
|
||||||
|
Learn how to use Qwen Code as an end user. This section covers:
|
||||||
|
- Basic installation and setup
|
||||||
|
- Common usage patterns
|
||||||
|
- Features and capabilities
|
||||||
|
- Configuration options
|
||||||
|
- Troubleshooting
|
||||||
|
|
||||||
|
### [Developer Guide](/developers/contributing)
|
||||||
|
Learn how to contribute to and develop Qwen Code. This section covers:
|
||||||
|
- Architecture overview
|
||||||
|
- Contributing guidelines
|
||||||
|
- Core concepts and implementation details
|
||||||
|
- Tools and development workflow
|
||||||
|
- Extension and plugin development
|
||||||
|
|||||||
@@ -27,22 +27,6 @@ npm install -g @qwen-code/qwen-code@latest
|
|||||||
brew install qwen-code
|
brew install qwen-code
|
||||||
```
|
```
|
||||||
|
|
||||||
**GitHub**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# clone GitHub project
|
|
||||||
git clone https://github.com/QwenLM/qwen-code.git
|
|
||||||
|
|
||||||
# go to qwen-code folder
|
|
||||||
cd qwen-code
|
|
||||||
|
|
||||||
# install npm
|
|
||||||
npm install
|
|
||||||
|
|
||||||
# install qwen-code
|
|
||||||
npm install -g @qwen-code/qwen-code@latest
|
|
||||||
```
|
|
||||||
|
|
||||||
### Start using Qwen Code:
|
### Start using Qwen Code:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@@ -54,13 +38,11 @@ You'll be prompted to log in on first use. That's it! [Continue with Quickstart
|
|||||||
|
|
||||||
> [!tip]
|
> [!tip]
|
||||||
>
|
>
|
||||||
> See [troubleshooting](/troubleshooting) if you hit issues.
|
> See [troubleshooting](/users/support/troubleshooting) if you hit issues.
|
||||||
|
|
||||||
> [!note]
|
> [!note]
|
||||||
>
|
>
|
||||||
> **New VS Code Extension (Beta)**: Prefer a graphical interface? Our new **VS Code extension** provides an easy-to-use native IDE experience without requiring terminal familiarity. Simply install from the marketplace and start coding with Qwen Code directly in your sidebar.
|
> **New VS Code Extension (Beta)**: Prefer a graphical interface? Our new **VS Code extension** provides an easy-to-use native IDE experience without requiring terminal familiarity. Simply install from the marketplace and start coding with Qwen Code directly in your sidebar. You can search for **Qwen Code** in the VS Code Marketplace and download it.
|
||||||
>
|
|
||||||
> 
|
|
||||||
|
|
||||||
## What Qwen Code does for you
|
## What Qwen Code does for you
|
||||||
|
|
||||||
|
|||||||
@@ -36,22 +36,6 @@ npm install -g @qwen-code/qwen-code@latest
|
|||||||
brew install qwen-code
|
brew install qwen-code
|
||||||
```
|
```
|
||||||
|
|
||||||
### GitHub
|
|
||||||
|
|
||||||
```sh
|
|
||||||
# clone GitHub project
|
|
||||||
git clone https://github.com/QwenLM/qwen-code.git
|
|
||||||
|
|
||||||
# go to qwen-code folder
|
|
||||||
cd qwen-code
|
|
||||||
|
|
||||||
# install npm
|
|
||||||
npm install
|
|
||||||
|
|
||||||
# install qwen-code
|
|
||||||
npm install -g @qwen-code/qwen-code@latest
|
|
||||||
```
|
|
||||||
|
|
||||||
## Step 2: Log in to your account
|
## Step 2: Log in to your account
|
||||||
|
|
||||||
Qwen Code requires an account to use. When you start an interactive session with the `qwen` command, you'll need to log in:
|
Qwen Code requires an account to use. When you start an interactive session with the `qwen` command, you'll need to log in:
|
||||||
@@ -70,7 +54,7 @@ Select `Qwen OAuth`, log in to your account and follow the prompts to confirm. O
|
|||||||
|
|
||||||
> [!note]
|
> [!note]
|
||||||
>
|
>
|
||||||
> When you first authenticate Qwen Code with your Qwen account, a workspace called "qwen-code" is automatically created for you. This workspace provides centralized cost tracking and management for all Qwen Code usage in your organization.
|
> When you first authenticate Qwen Code with your Qwen account, a workspace called ".qwen" is automatically created for you. This workspace provides centralized cost tracking and management for all Qwen Code usage in your organization.
|
||||||
|
|
||||||
> [!tip]
|
> [!tip]
|
||||||
>
|
>
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
# Uninstalling the CLI
|
# Uninstall
|
||||||
|
|
||||||
Your uninstall method depends on how you ran the CLI. Follow the instructions for either npx or a global npm installation.
|
Your uninstall method depends on how you ran the CLI. Follow the instructions for either npx or a global npm installation.
|
||||||
|
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
# Troubleshooting guide
|
# Troubleshooting
|
||||||
|
|
||||||
This guide provides solutions to common issues and debugging tips, including topics on:
|
This guide provides solutions to common issues and debugging tips, including topics on:
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user