📝 reorg getting started

yanyongyu · web-flow · commit d05a33420660 · 2026-03-28T04:47:54.000Z
diff --git a/docs/quickstart/index.md b/docs/quickstart/index.md
@@ -1,6 +1,6 @@
 # Quick Start
 
-Here are some common use cases to help you get started quickly. For more detailed usage, please refer to the [Usage](../usage/authentication.md) section.
+Here are some common use cases to help you get started quickly. For more detailed usage, please refer to the [Usage](../usage/getting-started/authentication.md) section.
 
 !!! note
 
diff --git a/docs/usage/getting-started/authentication.md b/docs/usage/getting-started/authentication.md
diff --git a/docs/usage/getting-started/configuration.md b/docs/usage/getting-started/configuration.md
@@ -177,7 +177,7 @@ Available built-in throttlers:
 
 ### `auto_retry`
 
-The `auto_retry` option enables request retrying when rate limit exceeded and server error encountered. See [Auto Retry](./auto-retry.md) for more infomation.
+The `auto_retry` option enables request retrying when rate limit exceeded and server error encountered. See [Auto Retry](../auto-retry.md) for more infomation.
 
 ### `rest_api_validate_body`
 
diff --git a/docs/usage/getting-started/reusing-client.md b/docs/usage/getting-started/reusing-client.md
@@ -0,0 +1,29 @@
+# Reusing Client
+
+You can make multiple requests with the same client instance in one context:
+
+=== "Sync"
+
+    ```python hl_lines="4"
+    from githubkit import GitHub, Response
+    from githubkit.versions.latest.models import FullRepository
+
+    with GitHub("<your_token_here>") as github:
+        resp: Response[FullRepository] = github.rest.repos.get(owner="owner", repo="repo")
+        repo: FullRepository = resp.parsed_data
+    ```
+
+=== "Async"
+
+    ```python hl_lines="4"
+    from githubkit import GitHub, Response
+    from githubkit.versions.latest.models import FullRepository
+
+    async with GitHub("<your_token_here>") as github:
+        resp: Response[FullRepository] = await github.rest.repos.async_get(owner="owner", repo="repo")
+        repo: FullRepository = resp.parsed_data
+    ```
+
+!!! warning
+
+    Repeatedly creating new client instances may lead to memory leaks. We recommend reusing the same client instance within a single context to avoid this issue.
diff --git a/docs/usage/rest-api.md b/docs/usage/rest-api.md
@@ -66,7 +66,7 @@ If you are calling an API that requires request body parameters, you can pass th
 
 !!! tip
 
-    By default, githubkit will validate the request body against the API schema. If you want to skip the validation, you can set the client config `rest_api_validate_body` to `False`. See [Configuration](./configuration.md#rest_api_validate_body) for more information.
+    By default, githubkit will validate the request body against the API schema. If you want to skip the validation, you can set the client config `rest_api_validate_body` to `False`. See [Configuration](./getting-started/configuration.md#rest_api_validate_body) for more information.
 
 Or you can pass the json request body as a dictionary:
 
@@ -179,36 +179,6 @@ In some cases, you may need to pass additional headers to the API request. You c
     content = resp.text
     ```
 
-## Reusing Client
-
-You can make multiple requests with the same client instance in one context:
-
-=== "Sync"
-
-    ```python hl_lines="4"
-    from githubkit import GitHub, Response
-    from githubkit.versions.latest.models import FullRepository
-
-    with GitHub("<your_token_here>") as github:
-        resp: Response[FullRepository] = github.rest.repos.get(owner="owner", repo="repo")
-        repo: FullRepository = resp.parsed_data
-    ```
-
-=== "Async"
-
-    ```python hl_lines="4"
-    from githubkit import GitHub, Response
-    from githubkit.versions.latest.models import FullRepository
-
-    async with GitHub("<your_token_here>") as github:
-        resp: Response[FullRepository] = await github.rest.repos.async_get(owner="owner", repo="repo")
-        repo: FullRepository = resp.parsed_data
-    ```
-
-!!! warning
-
-    Repeatedly creating new client instances may lead to memory leaks. We recommend reusing the same client instance within a single context to avoid this issue.
-
 ## Data Validation
 
 As shown above, the response data is parsed and validated by accessing the `response.parsed_data` property. This ensures that the data type returned by the API is as expected and your code is safe to use it (with static type checking). But sometimes you may want to get the raw data returned by the API, such as when the schema is not correct. You can use the `response.text` property or `response.json()` method to get the raw data. The loaded json data is also typed but not validated. For example:
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -131,8 +131,10 @@ nav:
       - OAuth APP Device Flow: quickstart/oauth-device-flow.md
       - GitHub APP: quickstart/github-app.md
   - Usage:
-      - Authentication: usage/authentication.md
-      - Configuration: usage/configuration.md
+      - Getting Started:
+          - Authentication: usage/getting-started/authentication.md
+          - Configuration: usage/getting-started/configuration.md
+          - Reusing Client: usage/getting-started/reusing-client.md
       - REST API: usage/rest-api.md
       - GraphQL: usage/graphql.md
       - Auto Retry: usage/auto-retry.md
