docs: cap.json endpoint + Models bring-your-own-key wizard

[indykish]

Summary

Post-merge docs follow-up for the cap.json endpoint + Models bring-your-own-key wizard, merged in usezombie/usezombie#373.

• Changelog — new <Update> (Jun 07, 2026): the Models bring-your-own-key wizard, and the public cap.json document that renames model-caps.json (old path 404s, no alias) and adds the global rates/billing block. models[] shape unchanged.
• CLI reference — zombiectl tenant provider set now names the cap.json endpoint (was "model-caps endpoint").

Notes

• The rename is documented as Breaking with an Upgrading step; only the path moves, so the per-model models[] shape is unchanged. The dashboard and zombiectl resolve it for the user.
• Historical changelog entries that mention model-caps.json are left intact (append-only history).

🤖 Generated with Claude Code

Greptile Summary

This PR adds changelog and CLI reference documentation for two features shipped in usezombie/usezombie#373: the Models BYOK wizard (inline credential creation on the Models page) and the rename of the public model catalogue endpoint from model-caps.json to cap.json.

• changelog.mdx — new <Update> block (Jun 07, 2026) covering the breaking path rename, the BYOK wizard UI flow, and a full API reference for GET /_um/<key>/cap.json with its { version, models, rates, billing } shape.
• cli/zombiectl.mdx — one-line update to zombiectl tenant provider set description replacing "model-caps endpoint" with `cap.json` endpoint.

Confidence Score: 5/5

Pure documentation update with no code changes; both files are internally consistent and accurately reflect the breaking rename.

Both changes are documentation-only. The changelog entry follows the fixed section order (Upgrading → What's new → API reference), uses the correct date label format, carries the Breaking tag, and documents the cap.json shape completely. The CLI reference change is a single accurate sentence update. No functional code is touched.

No files require special attention.

Important Files Changed

Filename	Overview
changelog.mdx	Adds a well-structured Breaking update entry with Upgrading, What's new, and API reference sections in the correct fixed order per AGENTS.md; terminology, heading case, and date label all conform to style guide.
cli/zombiectl.mdx	Single-sentence update to the zombiectl tenant provider set description correctly replacing the stale 'model-caps endpoint' reference with the renamed cap.json endpoint; no other changes.

Sequence Diagram

sequenceDiagram
    participant Client
    participant API as Public API (_um/<key>/)
    participant Dashboard
    participant zombiectl

    note over API: Path renamed: model-caps.json → cap.json

    Client->>API: "GET _um/<key>/cap.json (unauthenticated)"
    API-->>Client: "{ version, models[], rates, billing }"
    note right of Client: Wrong key → 404<br/>Empty catalogue → 503

    note over Dashboard: BYOK Wizard (new)
    Dashboard->>API: GET cap.json (populate model picker)
    API-->>Dashboard: models[] + global config
    Dashboard->>Dashboard: Detect provider from key prefix
    Dashboard->>Dashboard: Save credential inline
    Dashboard->>Dashboard: Activate model — no page hop

    zombiectl->>API: Resolve context cap via cap.json
    note right of zombiectl: zombiectl tenant provider set<br/>now references cap.json endpoint

Loading

_{Reviews (1): Last reviewed commit: "docs: changelog + CLI prose for cap.json..." | Re-trigger Greptile}

Context used:

• Context used - AGENTS.md (source)

[mintlify]

Preview deployment for your docs. Learn more about Mintlify Previews.

Project	Status	Preview	Updated (UTC)
megam	🟢 Ready	View Preview	Jun 7, 2026, 10:24 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.