You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@seatunnel.apache.org by "SEZ9 (via GitHub)" <gi...@apache.org> on 2026/07/24 15:17:20 UTC
[PR] [Docs][CLI] Add AI CLI documentation section (overview, quickstart, design, model benchmark) [seatunnel]
SEZ9 opened a new pull request, #11551:
URL: https://github.com/apache/seatunnel/pull/11551
### Purpose of this pull request
Adds a dedicated **AI CLI** documentation section to the website (English + Chinese), covering the `seatunnel-cli` module introduced in #10789. The module currently has no website documentation — usage, design rationale, and measured model accuracy are only discoverable through the module's README and scattered issues.
Four pages per locale (`docs/en/ai-cli/`, `docs/zh/ai-cli/`), plus a new "AI CLI" category in `sidebars.js` (shared by both locales):
| Page | Contents |
|------|----------|
| `overview` | Positioning, capabilities, relationship to the external tooling in apache/seatunnel-tools (Skill / MCP / x2seatunnel) |
| `quickstart` | Install (distribution / source), provider configuration (`bedrock`, `bedrock-mantle`, `anthropic`, OpenAI-compatible), single-shot & interactive usage, prompting tips |
| `design` | Why a multi-agent pipeline instead of a single LLM call; Planner → Config → Validator → Fix/Repair architecture; two-tier connector knowledge base; layered validation; design principles |
| `benchmark` | Measured accuracy of 7 LLMs on a 100-task suite with verdict gates up to real job execution; model behavior profiles; a model selection guide; known weak scenarios with a review-before-production note |
Notes for reviewers:
- The benchmark page carries an explicit dated-snapshot disclaimer (July 2026, CLI commit `59ada4ec0`) since model accuracy drifts.
- The Chinese pages are localized rewrites following existing zh docs conventions (terminology like source/sink/transform and BATCH/STREAMING kept in English), not literal translations.
- The `bedrock-mantle` provider referenced in quickstart is under review in #11548; if that PR's naming changes, this page will be updated accordingly.
- A "run the benchmark yourself" section is intentionally deferred until the discussion in #11549 (whether the benchmark harness joins the main repo) concludes.
Related: #10789, #11508/#11509, #11547/#11548, #11549
### Does this PR introduce _any_ user-facing change?
Yes — new documentation section on the website (en + zh). No code changes.
### How was this patch tested?
Docs-only change: verified en/zh structural parity (same filenames, sidebar_position, section hierarchy), sidebar entry syntax against the existing `sidebars.js` format, and relative links to the tools pages resolve.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@seatunnel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [Docs][CLI] Add AI CLI documentation section (overview, quickstart, design, model benchmark) [seatunnel]
Posted by "davidzollo (via GitHub)" <gi...@apache.org>.
davidzollo merged PR #11551:
URL: https://github.com/apache/seatunnel/pull/11551
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@seatunnel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org