Skip to content

Commit e64f3cf

Browse files
committed
docs: update codespaces accordingly
1 parent a430ca5 commit e64f3cf

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

doc/hands_on_codespace.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,17 @@ GitHub Codespace is a great option for developers who prefer to work in containe
33
## Create a codespace
44
1. In your browser, navigate to the [Official Repository of Azure CLI](https://github.com/Azure/azure-cli).
55
2. Above the file list, click **Code** > **Codespaces** > **Create codespace on dev**.
6-
![](./assets/codespace_entry.png)
6+
![](https://raw.githubusercontent.com/Azure/azure-cli/refs/heads/dev/doc/assets/codespace_entry.png)
77

88
With Codespace, all pre-requisites are installed for you, including the [AAZ Flow MCP server](https://github.com/Azure/azure-cli/tree/dev/tools/aaz-flow).
9-
![](./assets/codespace_mcp.png)
9+
![](https://raw.githubusercontent.com/Azure/azure-cli/refs/heads/dev/doc/assets/codespace_mcp.png)
1010

1111
## Authenticate with GitHub
1212
Once codespace is created (takes a while), you will see the following prompt in the integrated terminal:
13-
![](./assets/codespace_login.png)
13+
![](https://raw.githubusercontent.com/Azure/azure-cli/refs/heads/dev/doc/assets/codespace_login.png)
1414

1515
It helps login to your GitHub account interactively; after logging in, you won't need to do it again in a fresh terminal:
16-
![](./assets/codespace_logged.png)
16+
![](https://raw.githubusercontent.com/Azure/azure-cli/refs/heads/dev/doc/assets/codespace_logged.png)
1717

1818
Furthermore, all dependencies will be installed automatically, and once a similar prompt appears, you can start development:
1919
```commandline
@@ -36,16 +36,16 @@ It will convert the specification from https://github.com/Azure/azure-rest-api-s
3636
3737
### Prune command-line interface
3838
Typically, the interface generated directly from the specification isn’t ideal. You can refine it in the [Workspace Editor](https://azure.github.io/aaz-dev-tools/pages/usage/workspace-editor/) to make it meet our requirements. You can open or create a workspace at:
39-
![](./assets/codespace_workspace_editor_1.png)
39+
![](https://raw.githubusercontent.com/Azure/azure-cli/refs/heads/dev/doc/assets/codespace_workspace_editor_1.png)
4040

4141
If everything is selected correctly, you will be redirected to the following UI. You can interactively edit our ideal command line interface based on that:
42-
![](./assets/codespace_workspace_editor_2.png)
42+
![](https://raw.githubusercontent.com/Azure/azure-cli/refs/heads/dev/doc/assets/codespace_workspace_editor_2.png)
4343

4444
When you have completed all the editing in Workspace Editor and clicked EXPORT in its upper right corner. It's ready to switch to [CLI Generator](https://azure.github.io/aaz-dev-tools/pages/usage/cli-generator/) to generate code of Azure CLI:
4545
1. You need to select the target for generating code. If you don't know where to generate the code, usually Azure CLI Extension is all you need:
46-
![](./assets/codespace_cli_generator_1.png)
46+
![](https://raw.githubusercontent.com/Azure/azure-cli/refs/heads/dev/doc/assets/codespace_cli_generator_1.png)
4747
2. You can find the commands that you modified before in the following UI. Check the corresponding checkboxes, then click GENERATE in the upper right corner, and the code will be generated:
48-
![](./assets/codespace_cli_generator_2.png)
48+
![](https://raw.githubusercontent.com/Azure/azure-cli/refs/heads/dev/doc/assets/codespace_cli_generator_2.png)
4949

5050
### Implement custom logic (optional)
5151
Sometimes, the generated code may not fully meet the requirements. In such cases, you'll need to make some customizations based on it. This process can be relatively complex, so please refer to the [relevant documentation](https://azure.github.io/aaz-dev-tools/pages/usage/customization/).
@@ -65,11 +65,11 @@ Please note that AAZ Flow is currently in early development. The functionality a
6565

6666
### Tools
6767
You can easily start the MCP server within your codespace environment:
68-
![](./assets/codespace_mcp_start.png)
68+
![](https://raw.githubusercontent.com/Azure/azure-cli/refs/heads/dev/doc/assets/codespace_mcp_start.png)
6969

7070
Please setup your Copilot to use the AI features (**Ctrl** + **Alt** + **I** to open a chat):
71-
![](./assets/codespace_copilot.png)
71+
![](https://raw.githubusercontent.com/Azure/azure-cli/refs/heads/dev/doc/assets/codespace_copilot.png)
7272

73-
After that, set the mode to `Agent` and the model to `Claude Sonnet`. The following is the usage scenario of the tools:
74-
1. "generate test for chaos module" to generate test cases in `chaos` module.
75-
2. "generate code for azure cli" to generate models and codes.
73+
After that, set the mode to `Agent` and the model to `Claude Sonnet`. The following is the use case of the tools:
74+
1. "generate test for chaos module" to generate test cases in _chaos_ module.
75+
2. "generate code for azure cli" to generate models AND codes.

0 commit comments

Comments
 (0)