Skip to content

Docs/playground sprints - #18

Merged
Iamsdt merged 6 commits into
mainfrom
docs/playground-sprints
Oct 30, 2026
Merged

Iamsdt merged 6 commits into
mainfrom
docs/playground-sprints

Conversation

@Iamsdt

@Iamsdt Iamsdt commented Oct 30, 2026 •

Copy link
Copy Markdown
Contributor

Docs for the 1.0.0rc2 release and the playground sprints

Brings the docs in line with 10xgraph / 10xgraph-api 1.0.0rc2 and 10xgraph-client 1.0.0-rc.2, and with the playground changes from the audit sprints. Content only: no layout, theme or build changes.

What changed

Evals and testing (testing/, reference/api-cli)

  • 10xgraph eval writes JSON and HTML reports to eval_reports/ and opens the HTML report. Reports carry each case's expectations, the pass-rate gate and durations for user simulations.
  • Evals have no API endpoints or client methods; the playground opens the JSON report file.
  • The run trace is development only.

Server (server/)

  • File uploads: the new default limits (image pixels, PDF size and pages) and upload rules.
  • Server configuration and rate limiting brought up to date with 10xgraph.json.
  • Production checklist, deploy, Kubernetes, WebSockets, observability and playground pages updated to match.

OpenAI defaults (guides/, reference/python)

  • Agent uses the OpenAI Responses API by default; Chat Completions only with a custom base_url or api_style="chat". Usage notes updated.

Gemini Live model

  • Every reference to gemini-2.5-flash-live / gemini-live-2.5-flash-preview is now gemini-3.8-live, Google's current Live model.

Reference

  • Python, REST API, client and CLI reference pages updated for the message structure, eval report fields and the endpoints above.
  • Concepts, examples, compare, production, integrations, get-started and troubleshooting pages updated for the same changes.

Review notes

  • No new pages and no removed pages; existing links stay valid.
  • docs/production-positioning is already in main; this branch is based on it.

Checks

  • Site build: run npm run build (includes the search index) before merging.

- Remove the /v1/evals/runs reference and every mention of eval endpoints,
  `10xgraph eval --open` and the CLI HTML report; describe running
  `10xgraph eval` and opening the JSON in the playground Evals page.
- Run trace (GET /v1/observability) is a playground tool: off with
  MODE=production (nothing recorded, enabled: false), owner-only access.
- Playground page: Observability renamed to Run trace at /trace.
…e limiting

- Added detailed error responses for oversized PDF and image uploads in `files-and-multimodal.md`.
- Clarified cloud listing, quotas, and thread deletion processes in `files-and-multimodal.md`.
- Updated RBAC description for more precise scope definitions in `index.md`.
- Specified limits on nested request parameters in `invoke-and-stream.md`.
- Corrected content type for streaming results in `invoke-and-stream.md`.
- Improved Kubernetes deployment instructions, including graceful shutdown handling in `kubernetes.md`.
- Adjusted environment variable settings for production mode in `production-checklist.md`.
- Updated project setup instructions to reflect correct endpoint paths in `project-setup.md`.
- Standardized exclusion paths for rate limiting in `rate-limiting.md`.
- Enhanced WebSocket error handling and request limits in `websockets.md`.
- Clarified timeout environment variable naming in `providers.md`.
- Updated LLM timeout handling in `providers.md` to reflect new environment variable usage.
@Iamsdt
Iamsdt merged commit 2c8a175 into main Oct 30, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant