fengming 0.3.10 → 0.3.12

package/docs/providers/xiaomi.md

@@ -1,262 +0,0 @@
----
-summary: "Use Xiaomi MiMo pay-as-you-go and Token Plan models with FengMing"
-read_when:
-  - You want Xiaomi MiMo models in FengMing
-  - You need Xiaomi MiMo auth or Token Plan setup
-title: "Xiaomi MiMo"
----
-
-Xiaomi MiMo is the API platform for **MiMo** models. FengMing includes a bundled Xiaomi plugin with two text-provider presets:
-
-- `xiaomi` for pay-as-you-go keys (`sk-...`)
-- `xiaomi-token-plan` for Token Plan keys (`tp-...`) with regional endpoint presets
-
-The same plugin also registers the `xiaomi` speech (TTS) provider.
-
-| Property         | Value                                                                                                                                              |
-| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
-| Provider ids     | `xiaomi` (pay-as-you-go), `xiaomi-token-plan` (Token Plan)                                                                                         |
-| Plugin           | bundled, `enabledByDefault: true`                                                                                                                  |
-| Auth env vars    | `XIAOMI_API_KEY`, `XIAOMI_TOKEN_PLAN_API_KEY`                                                                                                      |
-| Onboarding flags | `--auth-choice xiaomi-api-key`, `--auth-choice xiaomi-token-plan-cn`, `--auth-choice xiaomi-token-plan-sgp`, `--auth-choice xiaomi-token-plan-ams` |
-| Direct CLI flags | `--xiaomi-api-key <key>`, `--xiaomi-token-plan-api-key <key>`                                                                                      |
-| Contracts        | chat completions + `speechProviders`                                                                                                               |
-| API              | OpenAI-compatible (`openai-completions`)                                                                                                           |
-| Base URLs        | Pay-as-you-go: `https://api.xiaomimimo.com/v1`; Token Plan presets: `token-plan-{cn,sgp,ams}...`                                                   |
-| Default models   | `xiaomi/mimo-v2-flash`, `xiaomi-token-plan/mimo-v2.5-pro`                                                                                          |
-| TTS default      | `mimo-v2.5-tts`, voice `mimo_default`                                                                                                              |
-
-## Getting started
-
-<Steps>
-  <Step title="Get the right key">
-    Create a pay-as-you-go key in the [Xiaomi MiMo console](https://platform.xiaomimimo.com/#/console/api-keys), or open your Token Plan subscription page and copy the regional OpenAI-compatible base URL plus the matching `tp-...` key.
-  </Step>
-
-  <Step title="Run onboarding">
-    Pay-as-you-go:
-
-    ```bash
-    fengming onboard --auth-choice xiaomi-api-key
-    ```
-
-    Token Plan:
-
-    ```bash
-    fengming onboard --auth-choice xiaomi-token-plan-sgp
-    ```
-
-    Or pass the keys directly:
-
-    ```bash
-    fengming onboard --auth-choice xiaomi-api-key --xiaomi-api-key "$XIAOMI_API_KEY"
-    fengming onboard --auth-choice xiaomi-token-plan-sgp --xiaomi-token-plan-api-key "$XIAOMI_TOKEN_PLAN_API_KEY"
-    ```
-
-  </Step>
-  <Step title="Verify the model is available">
-    ```bash
-    fengming models list --provider xiaomi
-    fengming models list --provider xiaomi-token-plan
-    ```
-  </Step>
-</Steps>
-
-## Pay-as-you-go catalog
-
-| Model ref              | Input       | Context   | Max output | Reasoning | Notes         |
-| ---------------------- | ----------- | --------- | ---------- | --------- | ------------- |
-| `xiaomi/mimo-v2-flash` | text        | 262,144   | 8,192      | No        | Default model |
-| `xiaomi/mimo-v2-pro`   | text        | 1,048,576 | 32,000     | Yes       | Large context |
-| `xiaomi/mimo-v2-omni`  | text, image | 262,144   | 32,000     | Yes       | Multimodal    |
-
-<Tip>
-The default model ref is `xiaomi/mimo-v2-flash`. The provider is injected automatically when `XIAOMI_API_KEY` is set or an auth profile exists.
-</Tip>
-
-## Token Plan catalog
-
-Choose the Token Plan auth choice that matches the regional base URL shown in Xiaomi's subscription UI:
-
-- `xiaomi-token-plan-cn` -> `https://token-plan-cn.xiaomimimo.com/v1`
-- `xiaomi-token-plan-sgp` -> `https://token-plan-sgp.xiaomimimo.com/v1`
-- `xiaomi-token-plan-ams` -> `https://token-plan-ams.xiaomimimo.com/v1`
-
-| Model ref                         | Input       | Context   | Max output | Reasoning | Notes         |
-| --------------------------------- | ----------- | --------- | ---------- | --------- | ------------- |
-| `xiaomi-token-plan/mimo-v2.5-pro` | text        | 1,048,576 | 32,000     | Yes       | Default model |
-| `xiaomi-token-plan/mimo-v2.5`     | text, image | 1,048,576 | 32,000     | Yes       | Multimodal    |
-
-<Tip>
-Token Plan onboarding validates the key shape and warns when a `tp-...` key is entered into the pay-as-you-go path, or an `sk-...` key is entered into the Token Plan path.
-</Tip>
-
-## Text-to-speech
-
-The bundled `xiaomi` plugin also registers Xiaomi MiMo as a speech provider for
-`messages.tts`. It calls Xiaomi's chat-completions TTS contract with the text as
-an `assistant` message and optional style guidance as a `user` message.
-
-| Property | Value                                    |
-| -------- | ---------------------------------------- |
-| TTS id   | `xiaomi` (`mimo` alias)                  |
-| Auth     | `XIAOMI_API_KEY`                         |
-| API      | `POST /v1/chat/completions` with `audio` |
-| Default  | `mimo-v2.5-tts`, voice `mimo_default`    |
-| Output   | MP3 by default; WAV when configured      |
-
-```json5
-{
-  messages: {
-    tts: {
-      auto: "always",
-      provider: "xiaomi",
-      providers: {
-        xiaomi: {
-          apiKey: "xiaomi_api_key",
-          model: "mimo-v2.5-tts",
-          speakerVoice: "mimo_default",
-          format: "mp3",
-          style: "Bright, natural, conversational tone.",
-        },
-      },
-    },
-  },
-}
-```
-
-Supported built-in voices include `mimo_default`, `default_zh`, `default_en`,
-`Mia`, `Chloe`, `Milo`, and `Dean`. `mimo-v2-tts` is supported for older MiMo
-TTS accounts; the default uses the current MiMo-V2.5 TTS model. For voice-note
-targets such as Feishu and Telegram, FengMing transcodes Xiaomi output to 48kHz
-Opus with `ffmpeg` before delivery.
-
-## Config example
-
-```json5
-{
-  env: { XIAOMI_API_KEY: "your-key" },
-  agents: { defaults: { model: { primary: "xiaomi/mimo-v2-flash" } } },
-  models: {
-    mode: "merge",
-    providers: {
-      xiaomi: {
-        baseUrl: "https://api.xiaomimimo.com/v1",
-        api: "openai-completions",
-        apiKey: "XIAOMI_API_KEY",
-        models: [
-          {
-            id: "mimo-v2-flash",
-            name: "Xiaomi MiMo V2 Flash",
-            reasoning: false,
-            input: ["text"],
-            contextWindow: 262144,
-            maxTokens: 8192,
-          },
-          {
-            id: "mimo-v2-pro",
-            name: "Xiaomi MiMo V2 Pro",
-            reasoning: true,
-            input: ["text"],
-            contextWindow: 1048576,
-            maxTokens: 32000,
-          },
-          {
-            id: "mimo-v2-omni",
-            name: "Xiaomi MiMo V2 Omni",
-            reasoning: true,
-            input: ["text", "image"],
-            contextWindow: 262144,
-            maxTokens: 32000,
-          },
-        ],
-      },
-    },
-  },
-}
-```
-
-Pricing and compat flags come from the bundled plugin manifest, so the config example omits `cost` and `compat` to avoid diverging from runtime behavior.
-
-Token Plan:
-
-```json5
-{
-  env: { XIAOMI_TOKEN_PLAN_API_KEY: "tp-your-key" },
-  agents: { defaults: { model: { primary: "xiaomi-token-plan/mimo-v2.5-pro" } } },
-  models: {
-    mode: "merge",
-    providers: {
-      "xiaomi-token-plan": {
-        baseUrl: "https://token-plan-sgp.xiaomimimo.com/v1",
-        api: "openai-completions",
-        apiKey: "XIAOMI_TOKEN_PLAN_API_KEY",
-        models: [
-          {
-            id: "mimo-v2.5-pro",
-            name: "Xiaomi MiMo V2.5 Pro",
-            reasoning: true,
-            input: ["text"],
-            contextWindow: 1048576,
-            maxTokens: 32000,
-          },
-          {
-            id: "mimo-v2.5",
-            name: "Xiaomi MiMo V2.5",
-            reasoning: true,
-            input: ["text", "image"],
-            contextWindow: 1048576,
-            maxTokens: 32000,
-          },
-        ],
-      },
-    },
-  },
-}
-```
-
-Pricing comes from the bundled manifest (Token Plan models include tiered cache-read pricing), so the config example omits `cost`.
-
-<AccordionGroup>
-  <Accordion title="Auto-injection behavior">
-    The `xiaomi` provider is injected automatically when `XIAOMI_API_KEY` is set in your environment or an auth profile exists. `xiaomi-token-plan` needs a regional base URL, so the supported path is the bundled Token Plan onboarding choice or an explicit `models.providers.xiaomi-token-plan` config block.
-  </Accordion>
-
-  <Accordion title="Model details">
-    - **mimo-v2-flash** — lightweight and fast, ideal for general-purpose text tasks. No reasoning support.
-    - **mimo-v2-pro** — supports reasoning with a 1M token context window for long-document workloads.
-    - **mimo-v2-omni** — reasoning-enabled multimodal model that accepts both text and image inputs.
-    - **mimo-v2.5-pro** — Token Plan default with Xiaomi's current V2.5 reasoning stack.
-    - **mimo-v2.5** — Token Plan multimodal V2.5 route.
-
-    <Note>
-    Pay-as-you-go models use the `xiaomi/` prefix. Token Plan models use the `xiaomi-token-plan/` prefix.
-    </Note>
-
-  </Accordion>
-
-  <Accordion title="Troubleshooting">
-    - If models do not appear, confirm the relevant key env var or auth profile is present and valid.
-    - For Token Plan, confirm the chosen onboarding region matches the subscription page base URL and that the key starts with `tp-`.
-    - When the Gateway runs as a daemon, ensure the key is available to that process (for example in `~/.fengming/.env` or via `env.shellEnv`).
-
-    <Warning>
-    Keys set only in your interactive shell are not visible to daemon-managed gateway processes. Use `~/.fengming/.env` or `env.shellEnv` config for persistent availability.
-    </Warning>
-
-  </Accordion>
-</AccordionGroup>
-
-## Related
-
-<CardGroup cols={2}>
-  <Card title="Model selection" href="/concepts/model-providers" icon="layers">
-    Choosing providers, model refs, and failover behavior.
-  </Card>
-  <Card title="Configuration reference" href="/gateway/configuration-reference" icon="gear">
-    Full FengMing configuration reference.
-  </Card>
-  <Card title="Xiaomi MiMo console" href="https://platform.xiaomimimo.com" icon="arrow-up-right-from-square">
-    Xiaomi MiMo dashboard and API key management.
-  </Card>
-</CardGroup>

package/docs/providers/zai.md

@@ -1,224 +0,0 @@
----
-summary: "Use Z.AI (GLM models) with FengMing"
-read_when:
-  - You want Z.AI / GLM models in FengMing
-  - You need a simple ZAI_API_KEY setup
-title: "Z.AI"
----
-
-Z.AI is the API platform for **GLM** models. It provides REST APIs for GLM and
-uses API keys for authentication. Create your API key in the Z.AI console.
-FengMing uses the `zai` provider with a Z.AI API key.
-
-| Property | Value                                        |
-| -------- | -------------------------------------------- |
-| Provider | `zai`                                        |
-| Auth     | `ZAI_API_KEY` (legacy alias: `Z_AI_API_KEY`) |
-| API      | Z.AI Chat Completions (Bearer auth)          |
-
-## GLM models
-
-GLM is a model family, not a separate provider. In FengMing, GLM models use
-refs such as `zai/glm-5.1`: provider `zai`, model id `glm-5.1`.
-
-## Getting started
-
-<Tabs>
-  <Tab title="Auto-detect endpoint">
-    **Best for:** most users. FengMing probes supported Z.AI endpoints with your API key and applies the correct base URL automatically.
-
-    <Steps>
-      <Step title="Run onboarding">
-        ```bash
-        fengming onboard --auth-choice zai-api-key
-        ```
-      </Step>
-      <Step title="Verify the model is listed">
-        ```bash
-        fengming models list --all --provider zai
-        ```
-      </Step>
-    </Steps>
-
-  </Tab>
-
-  <Tab title="Explicit regional endpoint">
-    **Best for:** users who want to force a specific Coding Plan or general API surface.
-
-    <Steps>
-      <Step title="Pick the right onboarding choice">
-        ```bash
-        # Coding Plan Global (recommended for Coding Plan users)
-        fengming onboard --auth-choice zai-coding-global
-
-        # Coding Plan CN (China region)
-        fengming onboard --auth-choice zai-coding-cn
-
-        # General API
-        fengming onboard --auth-choice zai-global
-
-        # General API CN (China region)
-        fengming onboard --auth-choice zai-cn
-        ```
-      </Step>
-      <Step title="Verify the model is listed">
-        ```bash
-        fengming models list --all --provider zai
-        ```
-      </Step>
-    </Steps>
-
-  </Tab>
-</Tabs>
-
-## Config example
-
-<Tip>
-`zai-api-key` lets FengMing detect the matching Z.AI endpoint from the key and
-apply the correct base URL automatically. Use the explicit regional choices when
-you want to force a specific Coding Plan or general API surface.
-</Tip>
-
-```json5
-{
-  env: { ZAI_API_KEY: "sk-..." },
-  models: {
-    providers: {
-      zai: {
-        // Example value. Onboarding writes the matching baseUrl for your endpoint.
-        baseUrl: "https://api.z.ai/api/paas/v4",
-      },
-    },
-  },
-  agents: { defaults: { model: { primary: "zai/glm-5.1" } } },
-}
-```
-
-## Built-in catalog
-
-FengMing ships the bundled `zai` provider catalog in the plugin manifest, so read-only
-listing can show known GLM rows without loading provider runtime:
-
-```bash
-fengming models list --all --provider zai
-```
-
-The manifest-backed catalog currently includes:
-
-| Model ref            | Notes         |
-| -------------------- | ------------- |
-| `zai/glm-5.1`        | Default model |
-| `zai/glm-5`          |               |
-| `zai/glm-5-turbo`    |               |
-| `zai/glm-5v-turbo`   |               |
-| `zai/glm-4.7`        |               |
-| `zai/glm-4.7-flash`  |               |
-| `zai/glm-4.7-flashx` |               |
-| `zai/glm-4.6`        |               |
-| `zai/glm-4.6v`       |               |
-| `zai/glm-4.5`        |               |
-| `zai/glm-4.5-air`    |               |
-| `zai/glm-4.5-flash`  |               |
-| `zai/glm-4.5v`       |               |
-
-<Tip>
-GLM models are available as `zai/<model>` (example: `zai/glm-5`).
-</Tip>
-
-<Note>
-The default bundled model ref is `zai/glm-5.1`. GLM versions and availability
-can change; run `fengming models list --all --provider zai` to see the catalog
-known to your installed version.
-</Note>
-
-## Advanced configuration
-
-<AccordionGroup>
-  <Accordion title="Forward-resolving unknown GLM-5 models">
-    Unknown `glm-5*` ids still forward-resolve on the bundled provider path by
-    synthesizing provider-owned metadata from the `glm-4.7` template when the id
-    matches the current GLM-5 family shape.
-  </Accordion>
-
-  <Accordion title="Tool-call streaming">
-    `tool_stream` is enabled by default for Z.AI tool-call streaming. To disable it:
-
-    ```json5
-    {
-      agents: {
-        defaults: {
-          models: {
-            "zai/<model>": {
-              params: { tool_stream: false },
-            },
-          },
-        },
-      },
-    }
-    ```
-
-  </Accordion>
-
-  <Accordion title="Thinking and preserved thinking">
-    Z.AI thinking follows FengMing's `/think` controls. With thinking off,
-    FengMing sends `thinking: { type: "disabled" }` to avoid responses that
-    spend the output budget on `reasoning_content` before visible text.
-
-    Preserved thinking is opt-in because Z.AI requires the full historical
-    `reasoning_content` to be replayed, which increases prompt tokens. Enable it
-    per model:
-
-    ```json5
-    {
-      agents: {
-        defaults: {
-          models: {
-            "zai/glm-5.1": {
-              params: { preserveThinking: true },
-            },
-          },
-        },
-      },
-    }
-    ```
-
-    When enabled and thinking is on, FengMing sends
-    `thinking: { type: "enabled", clear_thinking: false }` and replays prior
-    `reasoning_content` for the same OpenAI-compatible transcript.
-
-    Advanced users can still override the exact provider payload with
-    `params.extra_body.thinking`.
-
-  </Accordion>
-
-  <Accordion title="Image understanding">
-    The bundled Z.AI plugin registers image understanding.
-
-    | Property      | Value       |
-    | ------------- | ----------- |
-    | Model         | `glm-4.6v`  |
-
-    Image understanding is auto-resolved from the configured Z.AI auth — no
-    additional config is needed.
-
-  </Accordion>
-
-  <Accordion title="Auth details">
-    - Z.AI uses Bearer auth with your API key.
-    - The `zai-api-key` onboarding choice auto-detects the matching Z.AI endpoint by probing supported endpoints with your key.
-    - Use the explicit regional choices (`zai-coding-global`, `zai-coding-cn`, `zai-global`, `zai-cn`) when you want to force a specific API surface.
-    - The legacy env var `Z_AI_API_KEY` is still accepted; FengMing copies it to `ZAI_API_KEY` at startup if `ZAI_API_KEY` is unset.
-
-  </Accordion>
-</AccordionGroup>
-
-## Related
-
-<CardGroup cols={2}>
-  <Card title="Model selection" href="/concepts/model-providers" icon="layers">
-    Choosing providers, model refs, and failover behavior.
-  </Card>
-  <Card title="Configuration reference" href="/gateway/configuration-reference" icon="gear">
-    Full FengMing config schema, including provider and model settings.
-  </Card>
-</CardGroup>

package/docs/refactor/access.md

@@ -1,9 +0,0 @@
----
-summary: "Redirect to /refactor/ingress-core"
-read_when:
-  - Changing channel ingress, sender access, command authorization, or access-group handling
-title: "Channel access cleanup"
-sidebarTitle: "Channel access cleanup"
----
-
-The channel access cleanup plan now lives in [Ingress core deletion plan](/refactor/ingress-core).